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

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

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.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 QR code

Analytic events

Authorization

Request Body

Response Body

200image/png

400application/json

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

`image/png`

`application/json`