Format a Compact Credential as an Apple digital pass

This guide will show you how to format your Compact or Compact Semantic Credentials as an Apple digital pass.


You need the following in order to proceed with this tutorial: 

You must ensure your Apple developer certifications are valid when attempting to issue Apple digital passes. If you’re experiencing any difficulties, contact us


Make the following request to format a Compact Credential as an Apple digital pass:

Copy to clipboard.
1POST https://YOUR_TENANT_URL/core/v2/credentials/compact/digitalpass/apple

You can make a similar request to a different endpoint to format a Compact Semantic Credential as an Apple digital pass:

Copy to clipboard.
1POST https://YOUR_TENANT_URL/v2/credentials/compact-semantic/digitalpass/apple

Request body

Copy to clipboard.
2  "templateId": "1b04f0ee-8e3e-4153-a0e0-8603a10e7f0a",


The response includes a signed bundle .pkpass file (binary format).

Bad request (400) Errors may occur in the following scenarios:

  • Payload is not a string.

  • Payload does not match a Compact Credential profile.

  • Unable to validate or decode the payload.

  • Apple developer account credentials are missing or incorrect.

  • The template does not exist or is incorrectly defined.

  • Required config.json fields are not defined.

  • The file name contains a special character that is not supported by the Apple pass template endpoint.

  • The decoded payload is missing a required value for pass.json.

What's next?

Now that you have the Compact or Semantic Credential formatted as an Apple pass, you can share the .pkpass file using your selected communication channel (e.g. e-mail, messaging platform, etc.). It can then be downloaded by the recipient, saved into an Apple wallet and presented digitally to a verifier.