light-mode-image
Learn
MATTR VII PlatformCWT PDF templates

Retrieve a PDF template

Retrieves an existing CWT credentials PDF template using its ID.

Analytics Events

CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_STARTCREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_SUCCESSCREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_FAIL

Roles

adminissuer
GET/v2/credentials/compact/pdf/templates/{id}
AuthorizationBearer <token>

In: header

Path Parameters

idstring

PDF template ID

idstring

Response Body

curl -X GET "https://example.vii.au01.mattr.global/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"
    }
  ]
}
{
  "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"
    }
  ]
}

How would you rate this page?