light-mode-image
Learn
API Reference

Status update

Update Semantic CWT credential status

Update Semantic CWT credential revocation status

Updates the credential status as revoked (invalid) or unrevoked (valid).

Analytic events

  • CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_SET_STATUS_START
  • CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_SET_STATUS_SUCCESS
  • CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_SET_STATUS_FAIL
POST/v2/credentials/compact-semantic/{id}/revocation-status
AuthorizationBearer <token>

In: header

Path Parameters

idstring

Unique credential identifier (jti)

Update revocation status

isRevokedboolean

When set to true the credential will be revoked. When set to false, the credential will be unrevoked.

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/compact-semantic/string/revocation-status" \  -H "Content-Type: application/json" \  -d '{    "isRevoked": true  }'
{
  "id": "string",
  "isRevoked": true
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve Semantic CWT credential status

Retrieve Semantic CWT credential revocation status

Retrieve the revocation status of a Semantic CWT credential by providing its ID.

GET/v2/credentials/compact-semantic/{id}/revocation-status
AuthorizationBearer <token>

In: header

Path Parameters

idstring

Unique credential identifier (jti)

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/compact-semantic/string/revocation-status"
{
  "isRevoked": true
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?