Specifies paths and operations for managing CWT credentials PDF templates.
Create a PDF template
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.
Analytic events
- CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_START
- CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_SUCCESS
- CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_FAIL
Request Body schema: application/ziprequired
PDF template created
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
- 404
{- "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 PDF templates
Retrieves a list of all CWT credentials 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
PDF templates retrieved
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
- 404
{- "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"
}
]
}
]
}Update a PDF template
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.
Analytic events
- CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_START
- CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_SUCCESS
- CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_FAIL
PDF template updated
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
- 404
{- "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 PDF template
Retrieves an existing CWT credentials 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
PDF template retrieved
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
- 404
{- "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 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
PDF template deleted
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 400
- 404
{- "code": "string",
- "type": "string",
- "message": "string",
- "details": [
- {
- "value": "string",
- "msg": "Invalid value",
- "param": "id",
- "location": "body"
}
]
}