light-mode-image
Learn
API Reference

PDF templates

Create a CWT credential PDF template

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
POST/v2/credentials/compact/pdf/templates

Authorization

AuthorizationBearer <token>

In: header

Request Body

bodyfile
Formatbinary
curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/compact/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"
    }
  ]
}
{
  "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"
    }
  ]
}

Retrieve all CWT credential PDF templates

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
GET/v2/credentials/compact/pdf/templates

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Default100
Range1 <= value <= 1000
cursor?string

Starting point for the list of entries.

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/compact/pdf/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"
{
  "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"
        }
      ]
    }
  ]
}
{
  "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"
    }
  ]
}

Retrieve a CWT credential PDF template

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
GET/v2/credentials/compact/pdf/templates/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

PDF template ID

idstring
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"
    }
  ]
}

Update a CWT credential PDF template

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
PUT/v2/credentials/compact/pdf/templates/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

PDF template ID

idstring

Request Body

bodyfile
Formatbinary
curl -X PUT "https://example.vii.au01.mattr.global/v2/credentials/compact/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"
    }
  ]
}
{
  "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"
    }
  ]
}

Delete a CWT credential PDF template

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
DELETE/v2/credentials/compact/pdf/templates/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

PDF Template ID

idstring
curl -X DELETE "https://example.vii.au01.mattr.global/v2/credentials/compact/pdf/templates/string"
Empty
{
  "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?

Issuance

Previous Page

Apple Pass templates

Next Page

On this page

Create a CWT credential PDF templateRetrieve all CWT credential PDF templatesRetrieve a CWT credential PDF templateUpdate a CWT credential PDF templateDelete a CWT credential PDF template