light-mode-image
Learn
API Reference

Apple Pass templates

Create a CWT credential Apple Pass template

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

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"
{
  "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

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

Authorization

bearerAuth

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.

Response Body

application/json

application/json

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/compact/digital-pass/apple/templates"
{
  "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

GET/v2/credentials/compact/digital-pass/apple/templates/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Apple Pass template ID

Formatuuid
id*string

Apple Pass template ID

Response Body

application/json

application/json

application/json

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

PUT/v2/credentials/compact/digital-pass/apple/templates/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Apple Pass template ID

id*string

Apple Pass template ID

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

application/json

application/json

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/v2/credentials/compact/digital-pass/apple/templates/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Apple Pass template ID

Formatuuid
id*string

Apple Pass template ID

Response Body

application/json

application/json

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