Learn

Compact Credentials Apple Pass templates

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.

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
SecuritybearerAuth
Request
Request Body schema: multipart/form-data
required
template
required
string <binary>

Includes your template files.

name
required
string [ 1 .. 1024 ] characters

Insert a name to identify this Apple digital pass template.

fileName
required
string [ 1 .. 100 ] characters

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.

teamIdentifier
required
string

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

passTypeIdentifier
required
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
required
string

Apple G1 or G4 worldwide developer relations intermediate certificate.

signerCert
required
string

Apple pass signer certificate.

signerKey
required
string

The encrypted key of the Apple pass signer certificate.

signerKeyPassphrase
required
string

Passphrase for the encrypted key.

Responses
201

Apple Pass template created

400

Bad Request

post/v2/credentials/compact/digital-pass/apple/templates
Request samples 
Response samples 
application/json
{
  • "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
  • "passType": "apple",
  • "name": "Certificate of participation",
  • "metadata": {
    }
}
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
    • 



SecuritybearerAuth 
Request 
query Parameters
limit
number  [ 1 .. 1000 ] 
 Default:  100
Range size of the list, default 100


 
 Example:  limit=2
cursor
string
Starting point for the list


 
 Example:  cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses 
200
Apple Pass templates retrieved


400
Bad Request


get/v2/credentials/compact/digital-pass/apple/templates
Request samples 
Response samples 
application/json
{
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h",
  • "data": [
    ]
}
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
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
Apple Pass template ID


 
Request Body schema: multipart/form-data
required
template
required
string <binary> 
Includes your template files.


 
name
required
string  [ 1 .. 1024 ] characters 
Insert a name to identify this Apple digital pass template.


 
fileName
required
string  [ 1 .. 100 ] characters 
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.


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


 
passTypeIdentifier
required
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
required
string
Apple G1 or G4 worldwide developer relations intermediate certificate.


 
signerCert
required
string
Apple pass signer certificate.


 
signerKey
required
string
The encrypted key of the Apple pass signer certificate.


 
signerKeyPassphrase
required
string
Passphrase for the encrypted key.


 
Responses 
200
Apple Pass template updated


400
Bad Request


404
Not Found


put/v2/credentials/compact/digital-pass/apple/templates/{id}
Request samples 
Response samples 
application/json
{
  • "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
  • "passType": "apple",
  • "name": "Certificate of participation",
  • "metadata": {
    }
}
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
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Apple Pass template ID


 
Responses 
200
Apple Pass template retrieved


400
Bad Request


404
Not Found


get/v2/credentials/compact/digital-pass/apple/templates/{id}
Request samples 
Response samples 
application/json
{
  • "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
  • "passType": "apple",
  • "name": "Certificate of participation",
  • "metadata": {
    }
}
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
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Apple Pass template ID


 
Responses 
204
Apple Pass template deleted


400
Bad Request


404
Not Found


delete/v2/credentials/compact/digital-pass/apple/templates/{id}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}
➔ Next to Compact Credentials Google Pass templates