Status List Configuration

Create a Status List configuration

POST/v2/credentials/mobile/status-lists/configurations

Creates a Status list configuration, which defines a status list validity periods. mDocs can then be assigned to a specific Status list configuration.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_STARTMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_SUCCESSMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The Status list configuration payload

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/mobile/status-lists/configurations" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "983c0a86-204f-4431-9371-f5a22e506599",  "docType": "Drivers License",  "timeToLiveDuration": {    "days": 1  },  "expiryDuration": {    "days": 2  }}

Retrieve all Status List configurations

GET/v2/credentials/mobile/status-lists/configurations

Retrieves all Status list configurations from your tenant.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_STARTMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/mobile/status-lists/configurations"

{  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",  "data": [    {      "id": "983c0a86-204f-4431-9371-f5a22e506599",      "docType": "Drivers License",      "timeToLiveDuration": {        "days": 1      },      "expiryDuration": {        "days": 2      }    }  ]}

Retrieve a Status List configuration

GET/v2/credentials/mobile/status-lists/configurations/{statusListConfigurationId}

Retrieves an existing Status list configuration by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_STARTMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_SUCCESSMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

statusListConfigurationId*string

Status list configuration ID

Formatuuid

statusListConfigurationId*string

Status list configuration ID

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/mobile/status-lists/configurations/3948c40e-6e19-4ffc-933c-91f643f24264"

{  "docType": "DriverLicense",  "timeToLiveDuration": {    "days": 1  },  "expiryDuration": {    "days": 2  }}

Update a Status List configuration

PUT/v2/credentials/mobile/status-lists/configurations/{statusListConfigurationId}

Updates an existing Status list configuration, allowing you to adjust the expiry and TTL (Time To Live) settings.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_STARTMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_SUCCESSMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

statusListConfigurationId*string

Status list configuration ID

Formatuuid

statusListConfigurationId*string

Status list configuration ID

Formatuuid

Request Body

application/json

The Status list configuration payload

TypeScript Definitions

Use the request body type in TypeScript.

body*StatusListConfigurationUpdateRequest

Response Body

`application/json`

curl -X PUT "https://example.com/v2/credentials/mobile/status-lists/configurations/3948c40e-6e19-4ffc-933c-91f643f24264" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "983c0a86-204f-4431-9371-f5a22e506599",  "docType": "Drivers License",  "timeToLiveDuration": {    "days": 1  },  "expiryDuration": {    "days": 2  }}

Delete a Status List configuration

DELETE/v2/credentials/mobile/status-lists/configurations/{statusListConfigurationId}

Permanently deletes an existing Status list configuration.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_STARTMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_SUCCESSMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

statusListConfigurationId*string

Status list configuration ID

Formatuuid

statusListConfigurationId*string

Status list configuration ID

Formatuuid

Create a Status List configuration

POST/v2/credentials/mobile/status-lists/configurations

Creates a Status list configuration, which defines a status list validity periods. mDocs can then be assigned to a specific Status list configuration.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_STARTMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_SUCCESSMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The Status list configuration payload

TypeScript Definitions

Use the request body type in TypeScript.

docType*string

Status list configurations are unique per docType on your tenant. This value must match the type set when creating an mDoc credential configuration.

Length1 <= length <= 1024

timeToLiveDuration*

Defines how long relying parties can cache Status list tokens of this docType before it is recommended to retrieve a new Status list token from the tenant. Cannot exceed expiryDuration.

expiryDuration*

Defines how long relying parties can cache Status list tokens of this docType before they expire. Once a Status list token expires, relying parties can no longer use it to check credentials status and must retrieve a new one from the tenant. Regardless of the value of this parameter, Status list tokens expiry cannot exceed the validity of the IACA that is used to sign the Status list token.

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/mobile/status-lists/configurations" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "983c0a86-204f-4431-9371-f5a22e506599",  "docType": "Drivers License",  "timeToLiveDuration": {    "days": 1  },  "expiryDuration": {    "days": 2  }}

Retrieve all Status List configurations

GET/v2/credentials/mobile/status-lists/configurations

Retrieves all Status list configurations from your tenant.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_STARTMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/mobile/status-lists/configurations"

{  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",  "data": [    {      "id": "983c0a86-204f-4431-9371-f5a22e506599",      "docType": "Drivers License",      "timeToLiveDuration": {        "days": 1      },      "expiryDuration": {        "days": 2      }    }  ]}

Retrieve a Status List configuration

GET/v2/credentials/mobile/status-lists/configurations/{statusListConfigurationId}

Retrieves an existing Status list configuration by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_STARTMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_SUCCESSMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

statusListConfigurationId*string

Status list configuration ID

Formatuuid

statusListConfigurationId*string

Status list configuration ID

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/mobile/status-lists/configurations/3948c40e-6e19-4ffc-933c-91f643f24264"

{  "docType": "DriverLicense",  "timeToLiveDuration": {    "days": 1  },  "expiryDuration": {    "days": 2  }}

Update a Status List configuration

PUT/v2/credentials/mobile/status-lists/configurations/{statusListConfigurationId}

Updates an existing Status list configuration, allowing you to adjust the expiry and TTL (Time To Live) settings.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_STARTMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_SUCCESSMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

statusListConfigurationId*string

Status list configuration ID

Formatuuid

statusListConfigurationId*string

Status list configuration ID

Formatuuid

Request Body

application/json

The Status list configuration payload

TypeScript Definitions

Use the request body type in TypeScript.

body*StatusListConfigurationUpdateRequest

Response Body

`application/json`

curl -X PUT "https://example.com/v2/credentials/mobile/status-lists/configurations/3948c40e-6e19-4ffc-933c-91f643f24264" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "983c0a86-204f-4431-9371-f5a22e506599",  "docType": "Drivers License",  "timeToLiveDuration": {    "days": 1  },  "expiryDuration": {    "days": 2  }}

Delete a Status List configuration

DELETE/v2/credentials/mobile/status-lists/configurations/{statusListConfigurationId}

Permanently deletes an existing Status list configuration.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_STARTMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_SUCCESSMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

statusListConfigurationId*string

Status list configuration ID

Formatuuid

statusListConfigurationId*string

Status list configuration ID

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/credentials/mobile/status-lists/configurations/3948c40e-6e19-4ffc-933c-91f643f24264"

Empty

Status List Configuration

Roles

Analytics Events

201application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

Status List Configuration

Roles

Analytics Events

201application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`