Create an Apple Pass template

Creates an Apple Pass template based on the provided .zip file. Refer to our Design an Apple Pass template guide for more information on how to design the template and how to structure the .zip file.

The Apple Pass template uses the official Apple Pass bundle structure.

Analytics Events

CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_STARTCREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_SUCCESSCREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_FAIL

Roles

adminissuermanaged-issuer

POST/v2/credentials/compact/digital-pass/apple/templates

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

template*file

Includes your template files.

Formatbinary

name*string

Insert a name to identify this Apple digital pass template.

Length1 <= length <= 1024

fileName*string

Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with .pkpass.

Length1 <= length <= 100

teamIdentifier*string

The Team ID for the Apple Developer Program account that registered the pass type identifier.

passTypeIdentifier*string

The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.

wwdr*string

Apple G1 or G4 worldwide developer relations intermediate certificate.

signerCert*string

Apple pass signer certificate.

signerKey*string

The encrypted key of the Apple pass signer certificate.

signerKeyPassphrase*string

Passphrase for the encrypted key.

Response Body

`application/json`

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/compact/digital-pass/apple/templates" \
  -F template="string" \
  -F name="Certificate of participation" \
  -F fileName="certificate_of_participation.pkpass" \
  -F teamIdentifier="GH5P43ABC" \
  -F passTypeIdentifier="pass.myproject.participation.pk" \
  -F wwdr="string" \
  -F signerCert="string" \
  -F signerKey="string" \
  -F signerKeyPassphrase="string"

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/compact/digital-pass/apple/templates" \  -F template="string" \  -F name="Certificate of participation" \  -F fileName="certificate_of_participation.pkpass" \  -F teamIdentifier="GH5P43ABC" \  -F passTypeIdentifier="pass.myproject.participation.pk" \  -F wwdr="string" \  -F signerCert="string" \  -F signerKey="string" \  -F signerKeyPassphrase="string"

{
  "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
  "passType": "apple",
  "name": "Certificate of participation",
  "metadata": {
    "fileName": "certificate_of_participation.pkpass",
    "teamIdentifier": "GH5P43ABC",
    "passTypeIdentifier": "pass.myproject.participation.pk"
  }
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Create an Apple Pass template

Analytics Events

Roles

Authorization

Request Body

Response Body

201application/json

400application/json

`application/json`

`application/json`