light-mode-image
Learn
API Reference

Status List retrieval

Retrieve all Status lists

Retrieve all Status lists

Retrieves all existing status lists from your tenant.

Analytic events

  • MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_START
  • MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_SUCCESS
  • MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_FAIL
GET/v2/credentials/mobile/status-lists
AuthorizationBearer <token>

In: header

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/mobile/status-lists"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",
      "statusListConfigurationId": "0bd642d3-4a3b-4ce2-9f8f-151a73becaae",
      "listSize": 100000,
      "list": "0oRZAu6jEHRtYXR0ci1zdGF0dXNs..."
    }
  ]
}

Retrieve a Status list

Retrieve a Status list

Retrieves an existing Status list and its signed token by providing its ID.

Analytic events

  • MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_START
  • MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_SUCCESS
  • MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_FAIL
GET/v2/credentials/mobile/status-lists/{statusListId}
AuthorizationBearer <token>

In: header

Path Parameters

statusListIdstring

Status list unique identifier

Formatuuid
curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/mobile/status-lists/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",
  "statusListConfigurationId": "0bd642d3-4a3b-4ce2-9f8f-151a73becaae",
  "listSize": 100000,
  "list": "0oRZAu6jEHRtYXR0ci1zdGF0dXNs..."
}
{
  "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"
    }
  ]
}

Retrieve a Status list token

Retrieve a Status list token

Retrieves the Status list token in CWT format. This public end point returns a token which contains a compressed, signed list of credential statuses. Relying parties can use this token to check the revocation status of an mDoc that references this Status list.

Analytic events

  • MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_START
  • MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_SUCCESS
  • MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_FAIL
GET/v2/credentials/mobile/status-lists/{statusListId}/token

Path Parameters

statusListIdstring

Status list identifier

Formatuuid
curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/mobile/status-lists/497f6eca-6276-4993-bfeb-53cbbbba6f08/token"
"string"
{
  "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"
    }
  ]
}

Status list distribution

Status list distribution

Retrieves an object that details all existing Status lists tokens on the tenant. This public endpoint allows a relying party to consume and cache status lists. Each list in the response includes a URL where its token can be retrieved. Status list tokens that were signed by expired IACAs are excluded from the response.

Analytic events

  • MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_START
  • MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_SUCCESS
  • MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_FAIL
GET/v2/credentials/mobile/status-lists/distribution
curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/mobile/status-lists/distribution"
{
  "data": [
    {
      "status_lists": {
        "uri": "https://learn.vii.au01.mattr.global/v2/credentials/mobile/status-lists/{statusListId}"
      }
    }
  ]
}

How would you rate this page?