Status list retrieval

Specifies paths and operations for retrieving 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
Roles: ["admin","issuer"]
SecuritybearerAuth
Responses
200

Status lists retrieved

get/v2/credentials/mobile/status-lists
Request samples
Response samples
application/json
{
  • "data": [
    ]
}

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
Roles: ["admin","issuer"]
SecuritybearerAuth
Request
path Parameters
statusListId
required
string <uuid>

Status list unique identifier

Responses
200

Status list retrieved

400

Bad Request. The request was malformed or missing required parameters.

404

Not Found. The specified resource was not found.

get/v2/credentials/mobile/status-lists/{statusListId}
Request samples
Response samples
application/json
{
  • "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 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
Request
path Parameters
statusListId
required
string <uuid>

Status list identifier

Responses
200

Status list token retrieved

404

Not Found. The specified resource was not found.

410

Status list expired

get/v2/credentials/mobile/status-lists/{statusListId}/token
Request samples
Response samples
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}

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
Responses
200

Status lists retrieved

get/v2/credentials/mobile/status-lists/distribution
Request samples
Response samples
application/json