Issuance

Sign a CWT credential

POST/v2/credentials/compact/sign

Returns a signed CWT credential generated from a provided valid payload.

The payload can include any number of custom claims, as CWT credentials do not comply with any specific standard or specification.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SIGN_STARTCREDENTIAL_COMPACT_SIGN_SUCCESSCREDENTIAL_COMPACT_SIGN_FAIL

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": "did:web:organization.com",      "property1": "...",      "property2": "..."    }  }'

{  "id": "string",  "encoded": "CSC:/1/2KCE3IQEJB5DCMSLN5KWKZABE2QFQRVDAF4CIZDJMQ5HOZLCHIYDGOJUFUYTENJNGIZTOLJVGIWTCMJQFZXGO4TPNMXGS33ENZQW2ZLEJJXWQ3QH3BAFB3LISHKGQ2KBJ6Q35NXZFD6LGZ2YIAYHZAKCF7NKTIUZUTZQ3PWDBALAWVRG5XL2H4P4WFK25X3Y5X5RTN7NOZUST67KLCEFS3EPXQU5KM7VUGOPXJLQ6K5U676PMQNWRZCZ",  "decoded": {    "iss": "did:web:organization.com",    "nbf": 1645743759,    "exp": 1646743759,    "iat": 1645743759,    "jti": "6tVMmKodQNaLywW6NGA2aA",    "type": "CredentialType",    "property1": "...",    "property2": "..."  }}

Format a CWT credential as a QR code

POST/v2/credentials/compact/qrcode

Returns a QR code representation of a CWT credential from a provided encoded string representation of that credential.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_QRCODE_CREATE_STARTCREDENTIAL_COMPACT_QRCODE_CREATE_SUCCESSCREDENTIAL_COMPACT_QRCODE_CREATE_FAIL

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": "CSS:/1/2KCE3IQEJB5DCMSMGRKXI3IBE2QFSANKVACBUYQYB2HQKGTCDAHI6BQ2MIMA5DYBPAUWI2L..."  }'

"string"

Format a CWT credential as a PDF

POST/v2/credentials/compact/pdf

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

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_PDF_CREATE_STARTCREDENTIAL_COMPACT_PDF_CREATE_SUCCESSCREDENTIAL_COMPACT_PDF_CREATE_FAIL

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

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

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_APPLE_PASS_CREATE_STARTCREDENTIAL_COMPACT_APPLE_PASS_CREATE_SUCCESSCREDENTIAL_COMPACT_APPLE_PASS_CREATE_FAIL

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

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

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_STARTCREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_SUCCESSCREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_FAIL

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": "https://pay.google.com/gp/v/save/{jwt}"}

Sign a CWT credential

POST/v2/credentials/compact/sign

Returns a signed CWT credential generated from a provided valid payload.

The payload can include any number of custom claims, as CWT credentials do not comply with any specific standard or specification.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_SIGN_STARTCREDENTIAL_COMPACT_SIGN_SUCCESSCREDENTIAL_COMPACT_SIGN_FAIL

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": "did:web:organization.com",      "property1": "...",      "property2": "..."    }  }'

{  "id": "string",  "encoded": "CSC:/1/2KCE3IQEJB5DCMSLN5KWKZABE2QFQRVDAF4CIZDJMQ5HOZLCHIYDGOJUFUYTENJNGIZTOLJVGIWTCMJQFZXGO4TPNMXGS33ENZQW2ZLEJJXWQ3QH3BAFB3LISHKGQ2KBJ6Q35NXZFD6LGZ2YIAYHZAKCF7NKTIUZUTZQ3PWDBALAWVRG5XL2H4P4WFK25X3Y5X5RTN7NOZUST67KLCEFS3EPXQU5KM7VUGOPXJLQ6K5U676PMQNWRZCZ",  "decoded": {    "iss": "did:web:organization.com",    "nbf": 1645743759,    "exp": 1646743759,    "iat": 1645743759,    "jti": "6tVMmKodQNaLywW6NGA2aA",    "type": "CredentialType",    "property1": "...",    "property2": "..."  }}

Format a CWT credential as a QR code

POST/v2/credentials/compact/qrcode

Returns a QR code representation of a CWT credential from a provided encoded string representation of that credential.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_QRCODE_CREATE_STARTCREDENTIAL_COMPACT_QRCODE_CREATE_SUCCESSCREDENTIAL_COMPACT_QRCODE_CREATE_FAIL

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": "CSS:/1/2KCE3IQEJB5DCMSMGRKXI3IBE2QFSANKVACBUYQYB2HQKGTCDAHI6BQ2MIMA5DYBPAUWI2L..."  }'

"string"

Format a CWT credential as a PDF

POST/v2/credentials/compact/pdf

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

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_PDF_CREATE_STARTCREDENTIAL_COMPACT_PDF_CREATE_SUCCESSCREDENTIAL_COMPACT_PDF_CREATE_FAIL

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

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

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_APPLE_PASS_CREATE_STARTCREDENTIAL_COMPACT_APPLE_PASS_CREATE_SUCCESSCREDENTIAL_COMPACT_APPLE_PASS_CREATE_FAIL

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

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

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_STARTCREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_SUCCESSCREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_FAIL

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": "https://pay.google.com/gp/v/save/{jwt}"}

Roles

Analytics Events

200application/json

400application/json

Roles

Analytics Events

200image/png

400application/json

Roles

Analytics Events

200application/pdf

400application/json

404application/json

Roles

Analytics Events

200application/vnd.apple.pkpass

400application/json

Roles

Analytics Events

200application/json

400application/json

On this page

Issuance

Roles

Analytics Events

200application/json

400application/json

Roles

Analytics Events

200image/png

400application/json

Roles

Analytics Events

200application/pdf

400application/json

404application/json

Roles

Analytics Events

200application/vnd.apple.pkpass

400application/json

Roles

Analytics Events

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`