API Reference
PDF templates
Create a Semantic CWT credential PDF template
POST
/v2/credentials/compact-semantic/pdf/templatesAuthorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/zip
TypeScript Definitions
Use the request body type in TypeScript.
body*file
Format
binaryResponse Body
application/json
application/json
application/json
curl -X POST "https://example.com/v2/credentials/compact-semantic/pdf/templates" \ -H "Content-Type: application/zip" \ -d 'string'{ "id": "string", "name": "string", "fileName": "string", "fonts": [ { "name": "string", "fileName": "string" } ], "metadata": { "title": "string" }, "fields": [ { "key": "string", "value": "string", "isRequired": true, "alternativeText": "string", "fontName": "string" } ]}Retrieve all Semantic CWT credential PDF templates
GET
/v2/credentials/compact-semantic/pdf/templatesAuthorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
limit?number
Range size of returned list.
Range
1 <= value <= 1000Default
100cursor?string
Starting point for the list of entries.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v2/credentials/compact-semantic/pdf/templates"{ "nextCursor": "string", "data": [ { "id": "string", "name": "string", "fileName": "string", "fonts": [ { "name": "string", "fileName": "string" } ], "metadata": { "title": "string" }, "fields": [ { "key": "string", "value": "string", "isRequired": true, "alternativeText": "string", "fontName": "string" } ] } ]}Retrieve a Semantic CWT credential PDF template
GET
/v2/credentials/compact-semantic/pdf/templates/{id}Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
id*string
PDF Template ID
id*string
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v2/credentials/compact-semantic/pdf/templates/string"{ "id": "string", "name": "string", "fileName": "string", "fonts": [ { "name": "string", "fileName": "string" } ], "metadata": { "title": "string" }, "fields": [ { "key": "string", "value": "string", "isRequired": true, "alternativeText": "string", "fontName": "string" } ]}Update a Semantic CWT credential PDF template
PUT
/v2/credentials/compact-semantic/pdf/templates/{id}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
Format
binaryResponse Body
application/json
application/json
application/json
curl -X PUT "https://example.com/v2/credentials/compact-semantic/pdf/templates/string" \ -H "Content-Type: application/zip" \ -d 'string'{ "id": "string", "name": "string", "fileName": "string", "fonts": [ { "name": "string", "fileName": "string" } ], "metadata": { "title": "string" }, "fields": [ { "key": "string", "value": "string", "isRequired": true, "alternativeText": "string", "fontName": "string" } ]}Delete a Semantic CWT credential PDF template
DELETE
/v2/credentials/compact-semantic/pdf/templates/{id}Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
id*string
PDF Template ID
id*string
Response Body
application/json
application/json
curl -X DELETE "https://example.com/v2/credentials/compact-semantic/pdf/templates/string"Empty
How would you rate this page?
Last updated on