Issuance

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

CWT credential payload to sign

TypeScript Definitions

Use the request body type in TypeScript.

Sign CWT credential Request

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/compact/sign" \  -H "Content-Type: application/json" \  -d '{    "payload": {      "iss": "string",      "property1": "string",      "property2": "string"    }  }'

{  "id": "string",  "encoded": "string",  "decoded": {    "iss": "string",    "jti": "string",    "nbf": 0,    "exp": 0,    "iat": 0,    "aud": "string",    "sub": "string",    "type": "string",    "status": {      "url": "string",      "index": 0    },    "property1": "string",    "property2": "string"  }}

Format a CWT credential as a QR code

POST/v2/credentials/compact/qrcode

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`image/png`

`application/json`

curl -X POST "https://example.com/v2/credentials/compact/qrcode" \  -H "Content-Type: application/json" \  -d '{    "payload": "string"  }'

"string"

Format a CWT credential as a PDF

POST/v2/credentials/compact/pdf

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Credential payload

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/pdf`

`application/json`

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

null

Format a CWT credential as an Apple Pass

POST/v2/credentials/compact/digital-pass/apple

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*CreateDigitalPassRequest

Formatobject

Response Body

`application/vnd.apple.pkpass`

`application/json`

curl -X POST "https://example.com/v2/credentials/compact/digital-pass/apple" \  -H "Content-Type: application/json" \  -d '{    "templateId": "3812166c-ac9f-4e4e-96dd-c1336b5be378",    "payload": "{payload}"  }'

"string"

Format a CWT credential as a Google Pass

POST/v2/credentials/compact/digital-pass/google

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*CreateDigitalPassRequest

Formatobject

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/compact/digital-pass/google" \  -H "Content-Type: application/json" \  -d '{    "templateId": "3812166c-ac9f-4e4e-96dd-c1336b5be378",    "payload": "{payload}"  }'

{  "redirectTo": "string"}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

CWT credential payload to sign

TypeScript Definitions

Use the request body type in TypeScript.

Sign CWT credential Request

payload*

CompactCredentialSignRequest

revocable?boolean

When set to true, the signed credential can later be revoked. When set to false, the credential cannot be revoked.

Defaultfalse

isRevoked?boolean

When set to true, the signed credential is issued as revoked, and must be unrevoked to become valid. If isRevoked is provided (e.g. set to either true or false), revocable must be set to true.

Defaultfalse

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/compact/sign" \  -H "Content-Type: application/json" \  -d '{    "payload": {      "iss": "string",      "property1": "string",      "property2": "string"    }  }'

{  "id": "string",  "encoded": "string",  "decoded": {    "iss": "string",    "jti": "string",    "nbf": 0,    "exp": 0,    "iat": 0,    "aud": "string",    "sub": "string",    "type": "string",    "status": {      "url": "string",      "index": 0    },    "property1": "string",    "property2": "string"  }}

Format a CWT credential as a QR code

POST/v2/credentials/compact/qrcode

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

payload*string

String representation of the encoded CWT credential.

width?number

Optionally specify the desired width of the output QR code. When no width is specified MATTR VII will generate a QR code with an optimised width based on the size of the payload. Maximal value is 1000px.

Response Body

`image/png`

`application/json`

curl -X POST "https://example.com/v2/credentials/compact/qrcode" \  -H "Content-Type: application/json" \  -d '{    "payload": "string"  }'

"string"

Format a CWT credential as a PDF

POST/v2/credentials/compact/pdf

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Credential payload

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/pdf`

`application/json`

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

null

Format a CWT credential as an Apple Pass

POST/v2/credentials/compact/digital-pass/apple

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*CreateDigitalPassRequest

Formatobject

Response Body

`application/vnd.apple.pkpass`

`application/json`

curl -X POST "https://example.com/v2/credentials/compact/digital-pass/apple" \  -H "Content-Type: application/json" \  -d '{    "templateId": "3812166c-ac9f-4e4e-96dd-c1336b5be378",    "payload": "{payload}"  }'

"string"

Format a CWT credential as a Google Pass

POST/v2/credentials/compact/digital-pass/google

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*CreateDigitalPassRequest

Formatobject

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/compact/digital-pass/google" \  -H "Content-Type: application/json" \  -d '{    "templateId": "3812166c-ac9f-4e4e-96dd-c1336b5be378",    "payload": "{payload}"  }'

{  "redirectTo": "string"}

200application/json

400application/json

200image/png

400application/json

200application/pdf

400application/json

404application/json

200application/vnd.apple.pkpass

400application/json

200application/json

400application/json

On this page

Issuance

200application/json

400application/json

200image/png

400application/json

200application/pdf

400application/json

404application/json

200application/vnd.apple.pkpass

400application/json

200application/json

400application/json

On this page

`application/json`

`application/json`

`image/png`

`application/json`

`application/pdf`

`application/json`

`application/json`

`application/vnd.apple.pkpass`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`image/png`

`application/json`

`application/pdf`

`application/json`

`application/json`

`application/vnd.apple.pkpass`

`application/json`

`application/json`

`application/json`