light-mode-image
Learn
API Reference

Apple Pass templates

Create a CWT credential Apple Pass template

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.

Analytic events

  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_START
  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_SUCCESS
  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_FAIL
POST/v2/credentials/compact/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.

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"
    }
  ]
}

Retrieve all CWT credential Apple Pass templates

Retrieve all Apple Pass templates

Retrieves a list of all Apple Pass template available on the tenant.

Analytic events

  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_START
  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS
  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL
GET/v2/credentials/compact/digital-pass/apple/templates

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Default100
Range1 <= value <= 1000
cursor?string

Starting point for the list of entries.

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/compact/digital-pass/apple/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"
{
  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h",
  "data": [
    {
      "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"
    }
  ]
}

Retrieve a CWT credential Apple Pass template

Retrieve an Apple Pass template

Retrieves an existing Apple Pass template by providing its ID.

Analytic events

  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_START
  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_SUCCESS
  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_FAIL
GET/v2/credentials/compact/digital-pass/apple/templates/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

Apple Pass template ID

Formatuuid
idstring

Apple Pass template ID

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/compact/digital-pass/apple/templates/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"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Update a CWT credential Apple Pass template

Update an Apple Pass template

Updates an existing Apple Pass template by providing its ID and a .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.

Analytic events

  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_UPDATE_START
  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_UPDATE_SUCCESS
  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_UPDATE_FAIL
PUT/v2/credentials/compact/digital-pass/apple/templates/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

Apple Pass template ID

idstring

Apple Pass template ID

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.

curl -X PUT "https://example.vii.au01.mattr.global/v2/credentials/compact/digital-pass/apple/templates/string" \  -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"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Delete a CWT credential Apple Pass template

Delete an Apple Pass template

Deletes an existing Apple Pass template by providing its ID.

Analytic events

  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_DELETE_START
  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_DELETE_SUCCESS
  • CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_DELETE_FAIL
DELETE/v2/credentials/compact/digital-pass/apple/templates/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

Apple Pass template ID

Formatuuid
idstring

Apple Pass template ID

curl -X DELETE "https://example.vii.au01.mattr.global/v2/credentials/compact/digital-pass/apple/templates/string"
Empty
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?

PDF templates

Previous Page

Google Pass templates

Next Page

On this page

Create a CWT credential Apple Pass templateRetrieve all CWT credential Apple Pass templatesRetrieve a CWT credential Apple Pass templateUpdate a CWT credential Apple Pass templateDelete a CWT credential Apple Pass template