MATTR Learn

Sign a CWT credential

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.

Analytic events

CREDENTIAL_COMPACT_SIGN_START
CREDENTIAL_COMPACT_SIGN_SUCCESS
CREDENTIAL_COMPACT_SIGN_FAIL

POST/v2/credentials/compact/sign

Request Body

CWT credential payload to sign

payloadCompactCredentialSignRequest

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

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/compact/sign" \
  -H "Content-Type: application/json" \
  -d '{
    "payload": {
      "iss": "did:web:organization.com",
      "property1": "...",
      "property2": "..."
    }
  }'

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

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

Format a CWT credential as a QR code

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

Analytic events

CREDENTIAL_COMPACT_QRCODE_CREATE_START
CREDENTIAL_COMPACT_QRCODE_CREATE_SUCCESS
CREDENTIAL_COMPACT_QRCODE_CREATE_FAIL

POST/v2/credentials/compact/qrcode

Authorization

AuthorizationBearer <token>

In: header

Request Body

payloadstring

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.

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/compact/qrcode" \
  -H "Content-Type: application/json" \
  -d '{
    "payload": "CSS:/1/2KCE3IQEJB5DCMSMGRKXI3IBE2QFSANKVACBUYQYB2HQKGTCDAHI6BQ2MIMA5DYBPAUWI2L..."
  }'

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/compact/qrcode" \  -H "Content-Type: application/json" \  -d '{    "payload": "CSS:/1/2KCE3IQEJB5DCMSMGRKXI3IBE2QFSANKVACBUYQYB2HQKGTCDAHI6BQ2MIMA5DYBPAUWI2L..."  }'

"string"

{
  "code": "BadRequest",
  "message": "Validation Error",
  "details": [
    {
      "value": "1",
      "msg": "must be a string",
      "param": "payload",
      "location": "body"
    }
  ]
}

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.

Analytic events

CREDENTIAL_COMPACT_PDF_CREATE_START
CREDENTIAL_COMPACT_PDF_CREATE_SUCCESS
CREDENTIAL_COMPACT_PDF_CREATE_FAIL

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

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

Format a CWT credential as an Apple Pass

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

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

Analytic events

CREDENTIAL_COMPACT_APPLE_PASS_CREATE_START
CREDENTIAL_COMPACT_APPLE_PASS_CREATE_SUCCESS
CREDENTIAL_COMPACT_APPLE_PASS_CREATE_FAIL

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

Authorization

AuthorizationBearer <token>

In: header

Request Body

bodyCreateDigitalPassRequest

Formatobject

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

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

"string"

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

Format a CWT credential as a Google Pass

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

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

Analytic events

CREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_START
CREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_SUCCESS
CREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_FAIL

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

Authorization

AuthorizationBearer <token>

In: header

Request Body

bodyCreateDigitalPassRequest

Formatobject

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

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

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

Issuance

Sign a CWT credential

Sign a CWT credential

Analytic events

Authorization

Request Body

Format a CWT credential as a QR code

Format a CWT credential as a QR code

Analytic events

Authorization

Request Body

Format a CWT credential as a PDF

Format a CWT credential as a PDF

Analytic events

Authorization

Request Body

Format a CWT credential as an Apple Pass

Format a CWT credential as an Apple Pass

Analytic events

Authorization

Request Body

Format a CWT credential as a Google Pass

Format a CWT credential as a Google Pass

Analytic events

Authorization

Request Body

On this page

Issuance

Analytic events

Analytic events

Example Payload is not string

Example The payload does not belong to compact credential profile

Example The amount of data is too big to be stored in a QR Code

Example The generated QR Code is larger than the provided width

Analytic events

Analytic events

Analytic events

On this page