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.

ℹ️ Note: The Apple Pass template uses the official Apple Pass bundle structure.

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_STARTCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_FAIL

Roles

adminissuer

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

Authorization

AuthorizationBearer <token>

In: header

Request Body

templatefile

Includes your template files.

Formatbinary

namestring

Insert a name to identify this Apple digital pass template.

Length1 <= length <= 1024

fileNamestring

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

teamIdentifierstring

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

passTypeIdentifierstring

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

wwdrstring

Apple G1 or G4 worldwide developer relations intermediate certificate.

signerCertstring

Apple pass signer certificate.

signerKeystring

The encrypted key of the Apple pass signer certificate.

signerKeyPassphrasestring

Passphrase for the encrypted key.

Response Body

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/compact-semantic/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-semantic/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"
    }
  ]
}