Apple Pass templates

Create a Semantic CWT credential Apple Pass template

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

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.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_STARTCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/compact-semantic/digital-pass/apple/templates" \  -F template="string" \  -F name="string" \  -F fileName="string" \  -F teamIdentifier="string" \  -F passTypeIdentifier="string" \  -F wwdr="string" \  -F signerCert="string" \  -F signerKey="string" \  -F signerKeyPassphrase="string"

{  "id": "string",  "passType": "apple",  "name": "string",  "metadata": {    "fileName": "string",    "teamIdentifier": "string",    "passTypeIdentifier": "string"  }}

Retrieve all Semantic CWT credential Apple Pass templates

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

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

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_STARTCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/compact-semantic/digital-pass/apple/templates"

{  "nextCursor": "string",  "data": [    {      "id": "string",      "passType": "apple",      "name": "string",      "metadata": {        "fileName": "string",        "teamIdentifier": "string",        "passTypeIdentifier": "string"      }    }  ]}

Retrieve a Semantic CWT credential Apple Pass template

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

Retrieves an existing Apple Pass template by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_STARTCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Apple Pass template ID

Formatuuid

id*string

Template ID

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/compact-semantic/digital-pass/apple/templates/string"

{  "id": "string",  "passType": "apple",  "name": "string",  "metadata": {    "fileName": "string",    "teamIdentifier": "string",    "passTypeIdentifier": "string"  }}

Update a Semantic CWT credential Apple Pass template

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

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.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_STARTCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Apple Pass template ID

id*string

Template ID

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/v2/credentials/compact-semantic/digital-pass/apple/templates/string" \  -F template="string" \  -F name="string" \  -F fileName="string" \  -F teamIdentifier="string" \  -F passTypeIdentifier="string" \  -F wwdr="string" \  -F signerCert="string" \  -F signerKey="string" \  -F signerKeyPassphrase="string"

{  "id": "string",  "passType": "apple",  "name": "string",  "metadata": {    "fileName": "string",    "teamIdentifier": "string",    "passTypeIdentifier": "string"  }}

Delete a Semantic CWT credential Apple Pass template

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

Deletes an existing Apple Pass template by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_STARTCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Apple Pass template ID

Formatuuid

id*string

Template ID

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/credentials/compact-semantic/digital-pass/apple/templates/string"

Empty

Create a Semantic CWT credential Apple Pass template

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

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_STARTCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

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.com/v2/credentials/compact-semantic/digital-pass/apple/templates" \  -F template="string" \  -F name="string" \  -F fileName="string" \  -F teamIdentifier="string" \  -F passTypeIdentifier="string" \  -F wwdr="string" \  -F signerCert="string" \  -F signerKey="string" \  -F signerKeyPassphrase="string"

{  "id": "string",  "passType": "apple",  "name": "string",  "metadata": {    "fileName": "string",    "teamIdentifier": "string",    "passTypeIdentifier": "string"  }}

Retrieve all Semantic CWT credential Apple Pass templates

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

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

Roles

adminissuermanaged-issuer

Analytics Events

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/compact-semantic/digital-pass/apple/templates"

{  "nextCursor": "string",  "data": [    {      "id": "string",      "passType": "apple",      "name": "string",      "metadata": {        "fileName": "string",        "teamIdentifier": "string",        "passTypeIdentifier": "string"      }    }  ]}

Retrieve a Semantic CWT credential Apple Pass template

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

Retrieves an existing Apple Pass template by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_STARTCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Apple Pass template ID

Formatuuid

id*string

Template ID

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/compact-semantic/digital-pass/apple/templates/string"

{  "id": "string",  "passType": "apple",  "name": "string",  "metadata": {    "fileName": "string",    "teamIdentifier": "string",    "passTypeIdentifier": "string"  }}

Update a Semantic CWT credential Apple Pass template

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

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_STARTCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Apple Pass template ID

id*string

Template ID

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

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 PUT "https://example.com/v2/credentials/compact-semantic/digital-pass/apple/templates/string" \  -F template="string" \  -F name="string" \  -F fileName="string" \  -F teamIdentifier="string" \  -F passTypeIdentifier="string" \  -F wwdr="string" \  -F signerCert="string" \  -F signerKey="string" \  -F signerKeyPassphrase="string"

{  "id": "string",  "passType": "apple",  "name": "string",  "metadata": {    "fileName": "string",    "teamIdentifier": "string",    "passTypeIdentifier": "string"  }}

Delete a Semantic CWT credential Apple Pass template

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

Deletes an existing Apple Pass template by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_STARTCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Apple Pass template ID

Formatuuid

id*string

Template ID

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/credentials/compact-semantic/digital-pass/apple/templates/string"

Empty

Roles

Analytics Events

201application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

Apple Pass templates

Roles

Analytics Events

201application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`