Learn

Compact Credentials PDF templates

Create a PDF template

Creates a Compact Credential PDF template based on a provided .zip file. Refer to our PDF template design guide for more information on how to design a template and structure the .zip file.

Analytic events

  • CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_START
  • CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_SUCCESS
  • CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_FAIL
SecuritybearerAuth
Request
Request Body schema: application/zip
required
string <binary>
Responses
200

PDF template created

400

Bad Request

404

Not Found

post/v2/credentials/compact/pdf/templates
Request samples 
Response samples 
application/json
{
  • "id": "4eea7654-d4c5-4eba-bd7a-5ca334d54725",
  • "name": "Certificate of participation",
  • "fileName": "certificate_of_participation",
  • "fonts": [
    ],
  • "metadata": {
    },
  • "fields": [
    ]
}
Retrieve all PDF templates
Retrieves a list of all Compact Credential PDF templates available on the tenant.


Analytic events


    

  • CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_START
    • 

  • CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_SUCCESS
    • 

  • CREDENTIAL_COMPACT_PDF_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
PDF templates retrieved


400
Bad Request


404
Not Found


get/v2/credentials/compact/pdf/templates
Request samples 
Response samples 
application/json
{
  • "nextCursor": "0ecdcb57-ef2b-4aa1-be34-695c2d9d9486",
  • "data": [
    ]
}
Update a PDF template
Update an existing Compact Credential PDF template based on a provided .zip file. Refer to our PDF template design guide for more information on how to design a template and structure the .zip file.


Analytic events


    

  • CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_START
    • 

  • CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_SUCCESS
    • 

  • CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
PDF template ID


 
Request Body schema: application/zip
required
string <binary> 
 
Responses 
200
PDF template updated


400
Bad Request


404
Not Found


put/v2/credentials/compact/pdf/templates/{id}
Request samples 
Response samples 
application/json
{
  • "id": "4eea7654-d4c5-4eba-bd7a-5ca334d54725",
  • "name": "Certificate of participation",
  • "fileName": "certificate_of_participation",
  • "fonts": [
    ],
  • "metadata": {
    },
  • "fields": [
    ]
}
Retrieve a PDF template
Retrieves an existing Compact Credential PDF template using its ID.


Analytic events


    

  • CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_START
    • 

  • CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_SUCCESS
    • 

  • CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
PDF template ID


 
Responses 
200
PDF template retrieved


400
Bad Request


404
Not Found


get/v2/credentials/compact/pdf/templates/{id}
Request samples 
Response samples 
application/json
{
  • "id": "4eea7654-d4c5-4eba-bd7a-5ca334d54725",
  • "name": "Certificate of participation",
  • "fileName": "certificate_of_participation",
  • "fonts": [
    ],
  • "metadata": {
    },
  • "fields": [
    ]
}
Delete a PDF template
Delete an existing PDF template by providing its ID


Analytic events


    

  • CREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_START
    • 

  • CREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_SUCCESS
    • 

  • CREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
PDF Template ID


 
Responses 
204
PDF template deleted


400
Bad Request


404
Not Found


delete/v2/credentials/compact/pdf/templates/{id}
Request samples 
➔ Next to Compact Credentials Apple Pass templates