PDF templates

Create a CWT credential PDF template

POST

/v2/credentials/compact/pdf/templates

Creates a CWT 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.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_STARTCREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_SUCCESSCREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <token>

Request Body

body*fileapplication/zip

Formatbinary

Response Body

PDF template created

application/json

response

id?string

This is a unique identifier for this PDF template. You will use it as the templateId when formatting a CWT credential as a PDF.

name?string

Template name.

fileName?string

File name for credentials formatted using this template.

fonts?array<>

Includes any custom fonts in this template.

metadata?

fields?array<>

Includes the different elements in this PDF template and what fields in the credential they are mapped from.

curl -X POST "https://example.com/v2/credentials/compact/pdf/templates" \  -H "Content-Type: application/zip" \  -d 'string'

{  "id": "4eea7654-d4c5-4eba-bd7a-5ca334d54725",  "name": "Certificate of participation",  "fileName": "certificate_of_participation",  "fonts": [    {      "name": "PublicSans-Regular",      "fileName": "fonts/PublicSans-Regular.ttf"    }  ],  "metadata": {    "title": ""  },  "fields": [    {      "key": "familyName",      "value": "{{payload.sub_claims.familyName}}",      "isRequired": true,      "alternativeText": "{{payload.sub_claims.familyName}}",      "fontName": "PublicSans-Regular"    }  ]}

Retrieve all CWT credential PDF templates

GET

/v2/credentials/compact/pdf/templates

Retrieves a list of all CWT credentials PDF templates available on the tenant.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_STARTCREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_SUCCESSCREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <token>

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

PDF templates retrieved

application/json

response

nextCursor?string

data?array<>

curl -X GET "https://example.com/v2/credentials/compact/pdf/templates"

{  "nextCursor": "0ecdcb57-ef2b-4aa1-be34-695c2d9d9486",  "data": [    {      "id": "4eea7654-d4c5-4eba-bd7a-5ca334d54725",      "name": "Certificate of participation",      "fileName": "certificate_of_participation",      "fonts": [        {          "name": "PublicSans-Regular",          "fileName": "fonts/PublicSans-Regular.ttf"        }      ],      "metadata": {        "title": ""      },      "fields": [        {          "key": "familyName",          "value": "{{payload.sub_claims.familyName}}",          "isRequired": true,          "alternativeText": "{{payload.sub_claims.familyName}}",          "fontName": "PublicSans-Regular"        }      ]    }  ]}

Retrieve a CWT credential PDF template

GET

/v2/credentials/compact/pdf/templates/{id}

Retrieves an existing CWT credentials PDF template using its ID.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_STARTCREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_SUCCESSCREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <token>

Path Parameters

id*string

PDF template ID

Response Body

PDF template retrieved

application/json

response

id?string

This is a unique identifier for this PDF template. You will use it as the templateId when formatting a CWT credential as a PDF.

name?string

Template name.

fileName?string

File name for credentials formatted using this template.

fonts?array<>

Includes any custom fonts in this template.

metadata?

fields?array<>

Includes the different elements in this PDF template and what fields in the credential they are mapped from.

curl -X GET "https://example.com/v2/credentials/compact/pdf/templates/string"

{  "id": "4eea7654-d4c5-4eba-bd7a-5ca334d54725",  "name": "Certificate of participation",  "fileName": "certificate_of_participation",  "fonts": [    {      "name": "PublicSans-Regular",      "fileName": "fonts/PublicSans-Regular.ttf"    }  ],  "metadata": {    "title": ""  },  "fields": [    {      "key": "familyName",      "value": "{{payload.sub_claims.familyName}}",      "isRequired": true,      "alternativeText": "{{payload.sub_claims.familyName}}",      "fontName": "PublicSans-Regular"    }  ]}

Update a CWT credential PDF template

PUT

/v2/credentials/compact/pdf/templates/{id}

Update an existing CWT 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.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_STARTCREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_SUCCESSCREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <token>

Path Parameters

id*string

PDF template ID

Request Body

body*fileapplication/zip

Formatbinary

Response Body

PDF template updated

application/json

response

id?string

This is a unique identifier for this PDF template. You will use it as the templateId when formatting a CWT credential as a PDF.

name?string

Template name.

fileName?string

File name for credentials formatted using this template.

fonts?array<>

Includes any custom fonts in this template.

metadata?

fields?array<>

Includes the different elements in this PDF template and what fields in the credential they are mapped from.

curl -X PUT "https://example.com/v2/credentials/compact/pdf/templates/string" \  -H "Content-Type: application/zip" \  -d 'string'

{  "id": "4eea7654-d4c5-4eba-bd7a-5ca334d54725",  "name": "Certificate of participation",  "fileName": "certificate_of_participation",  "fonts": [    {      "name": "PublicSans-Regular",      "fileName": "fonts/PublicSans-Regular.ttf"    }  ],  "metadata": {    "title": ""  },  "fields": [    {      "key": "familyName",      "value": "{{payload.sub_claims.familyName}}",      "isRequired": true,      "alternativeText": "{{payload.sub_claims.familyName}}",      "fontName": "PublicSans-Regular"    }  ]}

Delete a CWT credential PDF template

DELETE

/v2/credentials/compact/pdf/templates/{id}

Delete an existing PDF template by providing its ID

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_STARTCREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_SUCCESSCREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <token>

Path Parameters

id*string

PDF Template ID

Response Body

PDF template deleted

curl -X DELETE "https://example.com/v2/credentials/compact/pdf/templates/string"

Empty

Create a CWT credential PDF template

POST

/v2/credentials/compact/pdf/templates

Creates a CWT 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.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_STARTCREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_SUCCESSCREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <token>

Request Body

body*fileapplication/zip

Formatbinary

Response Body

PDF template created

application/json

response

id?string

This is a unique identifier for this PDF template. You will use it as the templateId when formatting a CWT credential as a PDF.

name?string

Template name.

fileName?string

File name for credentials formatted using this template.

fonts?array<>

Includes any custom fonts in this template.

metadata?

fields?array<>

Includes the different elements in this PDF template and what fields in the credential they are mapped from.

curl -X POST "https://example.com/v2/credentials/compact/pdf/templates" \  -H "Content-Type: application/zip" \  -d 'string'

{  "id": "4eea7654-d4c5-4eba-bd7a-5ca334d54725",  "name": "Certificate of participation",  "fileName": "certificate_of_participation",  "fonts": [    {      "name": "PublicSans-Regular",      "fileName": "fonts/PublicSans-Regular.ttf"    }  ],  "metadata": {    "title": ""  },  "fields": [    {      "key": "familyName",      "value": "{{payload.sub_claims.familyName}}",      "isRequired": true,      "alternativeText": "{{payload.sub_claims.familyName}}",      "fontName": "PublicSans-Regular"    }  ]}

Retrieve all CWT credential PDF templates

GET

/v2/credentials/compact/pdf/templates

Retrieves a list of all CWT credentials PDF templates available on the tenant.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_STARTCREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_SUCCESSCREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <token>

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

PDF templates retrieved

application/json

response

nextCursor?string

data?array<>

curl -X GET "https://example.com/v2/credentials/compact/pdf/templates"

{  "nextCursor": "0ecdcb57-ef2b-4aa1-be34-695c2d9d9486",  "data": [    {      "id": "4eea7654-d4c5-4eba-bd7a-5ca334d54725",      "name": "Certificate of participation",      "fileName": "certificate_of_participation",      "fonts": [        {          "name": "PublicSans-Regular",          "fileName": "fonts/PublicSans-Regular.ttf"        }      ],      "metadata": {        "title": ""      },      "fields": [        {          "key": "familyName",          "value": "{{payload.sub_claims.familyName}}",          "isRequired": true,          "alternativeText": "{{payload.sub_claims.familyName}}",          "fontName": "PublicSans-Regular"        }      ]    }  ]}

Retrieve a CWT credential PDF template

GET

/v2/credentials/compact/pdf/templates/{id}

Retrieves an existing CWT credentials PDF template using its ID.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_STARTCREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_SUCCESSCREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <token>

Path Parameters

id*string

PDF template ID

Response Body

PDF template retrieved

application/json

response

id?string

This is a unique identifier for this PDF template. You will use it as the templateId when formatting a CWT credential as a PDF.

name?string

Template name.

fileName?string

File name for credentials formatted using this template.

fonts?array<>

Includes any custom fonts in this template.

metadata?

fields?array<>

Includes the different elements in this PDF template and what fields in the credential they are mapped from.

curl -X GET "https://example.com/v2/credentials/compact/pdf/templates/string"

{  "id": "4eea7654-d4c5-4eba-bd7a-5ca334d54725",  "name": "Certificate of participation",  "fileName": "certificate_of_participation",  "fonts": [    {      "name": "PublicSans-Regular",      "fileName": "fonts/PublicSans-Regular.ttf"    }  ],  "metadata": {    "title": ""  },  "fields": [    {      "key": "familyName",      "value": "{{payload.sub_claims.familyName}}",      "isRequired": true,      "alternativeText": "{{payload.sub_claims.familyName}}",      "fontName": "PublicSans-Regular"    }  ]}

Update a CWT credential PDF template

PUT

/v2/credentials/compact/pdf/templates/{id}

Update an existing CWT 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.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_STARTCREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_SUCCESSCREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <token>

Path Parameters

id*string

PDF template ID

Request Body

body*fileapplication/zip

Formatbinary

Response Body

PDF template updated

application/json

response

id?string

This is a unique identifier for this PDF template. You will use it as the templateId when formatting a CWT credential as a PDF.

name?string

Template name.

fileName?string

File name for credentials formatted using this template.

fonts?array<>

Includes any custom fonts in this template.

metadata?

fields?array<>

Includes the different elements in this PDF template and what fields in the credential they are mapped from.

curl -X PUT "https://example.com/v2/credentials/compact/pdf/templates/string" \  -H "Content-Type: application/zip" \  -d 'string'

{  "id": "4eea7654-d4c5-4eba-bd7a-5ca334d54725",  "name": "Certificate of participation",  "fileName": "certificate_of_participation",  "fonts": [    {      "name": "PublicSans-Regular",      "fileName": "fonts/PublicSans-Regular.ttf"    }  ],  "metadata": {    "title": ""  },  "fields": [    {      "key": "familyName",      "value": "{{payload.sub_claims.familyName}}",      "isRequired": true,      "alternativeText": "{{payload.sub_claims.familyName}}",      "fontName": "PublicSans-Regular"    }  ]}

Delete a CWT credential PDF template

DELETE

/v2/credentials/compact/pdf/templates/{id}

Delete an existing PDF template by providing its ID

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_STARTCREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_SUCCESSCREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_FAIL

curl -X DELETE "https://example.com/v2/credentials/compact/pdf/templates/string"

Empty

Create a CWT credential PDF templateCopy Anchor Link

Roles

Analytics Events

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Retrieve all CWT credential PDF templatesCopy Anchor Link

Roles

Analytics Events

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Retrieve a CWT credential PDF templateCopy Anchor Link

Roles

Analytics Events

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Update a CWT credential PDF templateCopy Anchor Link

Roles

Analytics Events

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Delete a CWT credential PDF templateCopy Anchor Link

Roles

Analytics Events

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

On this page

PDF templates

Create a CWT credential PDF templateCopy Anchor Link

Roles

Analytics Events

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Retrieve all CWT credential PDF templatesCopy Anchor Link

Roles

Analytics Events

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Retrieve a CWT credential PDF templateCopy Anchor Link

Roles

Analytics Events

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Update a CWT credential PDF templateCopy Anchor Link

Roles

Analytics Events

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Delete a CWT credential PDF templateCopy Anchor Link

Roles

Analytics Events

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

On this page

Create a CWT credential PDF template

Authorization

Request Body

Response Body

Retrieve all CWT credential PDF templates

Authorization

Query Parameters

Response Body

Retrieve a CWT credential PDF template

Authorization

Path Parameters

Response Body

Update a CWT credential PDF template

Authorization

Path Parameters

Request Body

Response Body

Delete a CWT credential PDF template

Authorization

Path Parameters

Response Body

Create a CWT credential PDF template

Authorization

Request Body

Response Body

Retrieve all CWT credential PDF templates

Authorization

Query Parameters

Response Body

Retrieve a CWT credential PDF template

Authorization

Path Parameters

Response Body

Update a CWT credential PDF template

Authorization

Path Parameters

Request Body

Response Body

Delete a CWT credential PDF template

Authorization

Path Parameters

Response Body