light-mode-image
Learn
API ReferenceStatus list retrieval

Status list distribution

Analytics Events

MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_STARTMOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_SUCCESSMOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_FAIL
GET/v2/credentials/mobile/status-lists/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

Response Body

application/json

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?

Retrieve a Status list token GET

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

Update mDoc status POST

Sets the status of an existing mDoc by providing its `credentialId` and the new status. Status can only be **valid**, **suspended** or **invalid**. Once an mDoc's status is updated to **invalid**, it cannot be updated again to any other value. ### **Analytic events** * MOBILE_CREDENTIAL_STATUS_SET_START * MOBILE_CREDENTIAL_STATUS_SET_SUCCESS * MOBILE_CREDENTIAL_STATUS_SET_FAIL