PDF templates

Create a Semantic CWT credential PDF template

POST/v2/credentials/compact-semantic/pdf/templates

Creates a Semantic 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_SEMANTIC_PDF_TEMPLATE_CREATE_STARTCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_CREATE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/zip

TypeScript Definitions

Use the request body type in TypeScript.

body*file

Formatbinary

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/compact-semantic/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 Semantic CWT credential PDF templates

GET/v2/credentials/compact-semantic/pdf/templates

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

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_LIST_STARTCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_LIST_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_PDF_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/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 Semantic CWT credential PDF template

GET/v2/credentials/compact-semantic/pdf/templates/{id}

Retrieves an existing Semantic CWT credential PDF template using its ID.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_STARTCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

PDF Template ID

id*string

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/compact-semantic/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 Semantic CWT credential PDF template

PUT/v2/credentials/compact-semantic/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_SEMANTIC_PDF_TEMPLATE_UPDATE_STARTCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

PDF Template ID

id*string

Request Body

application/zip

TypeScript Definitions

Use the request body type in TypeScript.

body*file

Formatbinary

Response Body

`application/json`

curl -X PUT "https://example.com/v2/credentials/compact-semantic/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 Semantic CWT credential PDF template

DELETE/v2/credentials/compact-semantic/pdf/templates/{id}

Delete an existing PDF template by providing its ID

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_STARTCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

PDF Template ID

id*string

Response Body

`application/json`

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

Empty

Create a Semantic CWT credential PDF template

POST/v2/credentials/compact-semantic/pdf/templates

Creates a Semantic 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_SEMANTIC_PDF_TEMPLATE_CREATE_STARTCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_CREATE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/zip

TypeScript Definitions

Use the request body type in TypeScript.

body*file

Formatbinary

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/compact-semantic/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 Semantic CWT credential PDF templates

GET/v2/credentials/compact-semantic/pdf/templates

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

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_LIST_STARTCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_LIST_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_PDF_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/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 Semantic CWT credential PDF template

GET/v2/credentials/compact-semantic/pdf/templates/{id}

Retrieves an existing Semantic CWT credential PDF template using its ID.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_STARTCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

PDF Template ID

id*string

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/compact-semantic/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 Semantic CWT credential PDF template

PUT/v2/credentials/compact-semantic/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_SEMANTIC_PDF_TEMPLATE_UPDATE_STARTCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

PDF Template ID

id*string

Request Body

application/zip

TypeScript Definitions

Use the request body type in TypeScript.

body*file

Formatbinary

Response Body

`application/json`

curl -X PUT "https://example.com/v2/credentials/compact-semantic/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 Semantic CWT credential PDF template

DELETE/v2/credentials/compact-semantic/pdf/templates/{id}

Delete an existing PDF template by providing its ID

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_STARTCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

PDF Template ID

id*string

Response Body

`application/json`

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

Empty

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

200application/json

400application/json

404application/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

PDF templates

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

200application/json

400application/json

404application/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`

`application/json`

`application/json`

`application/json`

`application/json`