Format a CWT credential as a PDF

Returns a PDF representation of a provided CWT credential based on an existing PDF template.

ℹ️ Note: The request will fail if the provided credential isn't valid or has expired.

Analytics Events

CREDENTIAL_COMPACT_PDF_CREATE_STARTCREDENTIAL_COMPACT_PDF_CREATE_SUCCESSCREDENTIAL_COMPACT_PDF_CREATE_FAIL

Roles

adminissuer

POST/v2/credentials/compact/pdf

Authorization

AuthorizationBearer <token>

In: header

Request Body

Credential payload

templateId?string

Use the ID element of the PDF template to be used to format this credential.

Length1 <= length

payload?string

String payload representation of the encoded CWT credential.

Length1 <= length <= 1024

Response Body

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/compact/pdf" \
  -H "Content-Type: application/json" \
  -d '{
    "templateId": "4eea7654-d4c5-4eba-bd7a-5ca334d54725",
    "payload": "{payload}"
  }'

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/compact/pdf" \  -H "Content-Type: application/json" \  -d '{    "templateId": "4eea7654-d4c5-4eba-bd7a-5ca334d54725",    "payload": "{payload}"  }'

null

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}