MATTR Learn

Sign a Semantic CWT credential

POST/v2/credentials/compact-semantic/sign

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Semantic CWT credential payload to sign

payload*

CompactSemanticCredentialSignRequest

revocable?boolean

When set to true, the created 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.vii.au01.mattr.global/v2/credentials/compact-semantic/sign" \  -H "Content-Type: application/json" \  -d '{    "payload": {      "iss": "did:web:organization.com",      "vc": {        "type": "AlumniCredential",        "credentialSubject": {          "property1": "...",          "property2": "..."        }      }    }  }'

{
  "id": "string",
  "encoded": "CSS:/1/BASE_32_ENCODED_PAYLOAD",
  "decoded": {
    "iss": "did:web:example.com",
    "jti": "...",
    "nbf": 1645743759,
    "exp": 1645743759,
    "iat": 1645743759,
    "aud": "...",
    "sub": "...",
    "vc": {
      "@context": [
        "https://www.w3.org/2018/credentials/v1",
        "https://www.w3.org/2018/credentials/examples/v1"
      ],
      "type": [
        "VerifiableCredential",
        "AlumniCredential"
      ],
      "credentialSubject": {
        "property1": "...",
        "property2": "..."
      }
    },
    "status": {
      "url": "...",
      "index": 123
    }
  }
}

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

Format a Semantic CWT credential as a QR code

POST/v2/credentials/compact-semantic/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-semantic/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 Semantic CWT credential as a PDF

POST/v2/credentials/compact-semantic/pdf

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The 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

Response Body

`application/pdf`

`application/json`

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/compact-semantic/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 Semantic CWT credential as an Apple Pass

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

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

body*unknown

Formatobject

Response Body

`application/vnd.apple.pkpass`

`application/json`

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/compact-semantic/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 Semantic CWT credential as a Google Pass

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

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

body*unknown

Formatobject

Response Body

`application/json`

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/compact-semantic/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 Semantic CWT credential

Authorization

Request Body

Response Body

`application/json`

`application/json`

Format a Semantic CWT credential as a QR code

Authorization

Request Body

Response Body

`image/png`

`application/json`

Format a Semantic CWT credential as a PDF

Authorization

Request Body

Response Body

`application/pdf`

`application/json`

`application/json`

Format a Semantic CWT credential as an Apple Pass

Authorization

Request Body

Response Body

`application/vnd.apple.pkpass`

`application/json`

Format a Semantic CWT credential as a Google Pass

Authorization

Request Body

Response Body

`application/json`

`application/json`

On this page

Issuance

200application/json

400application/json

200image/png

400application/json

Example Payload is not string

Example The payload does not belong to compact semantic 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

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`