Learn

Status list configuration

Specifies paths and operations for managing status list configuration.

Create a Status list configuration

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

Analytic events

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_START
  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_SUCCESS
  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_FAIL
Roles: ["admin","issuer"]
SecuritybearerAuth
Request
Request Body schema: application/json
required

The Status list configuration payload

docType
required
string [ 1 .. 1024 ] characters

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

timeToLiveDuration
required
object

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
required
object

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.

Responses
201

Status list configuration created

400

Bad Request

post/v2/credentials/mobile/status-lists/configurations
Request samples
application/json
{
  • "docType": "DriverLicense",
  • "timeToLiveDuration": {
    },
  • "expiryDuration": {
    }
}
Response samples
application/json
{
  • "id": "983c0a86-204f-4431-9371-f5a22e506599",
  • "docType": "Drivers LIcense",
  • "timeToLiveDuration": {
    },
  • "expiryDuration": {
    }
}

Retrieve all Status list configurations

Retrieves all Status list configurations from your tenant.

Analytic events

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_START
  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_
  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_FAIL
Roles: ["admin","issuer"]
SecuritybearerAuth
Request
query Parameters
limit
number [ 1 .. 1000 ]
Default: 100

Range size of returned list.

Example: limit=2
cursor
string

Starting point for the list of entries.

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses
200

Status list configurations retrieved

400

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

get/v2/credentials/mobile/status-lists/configurations
Request samples 
Response samples 
application/json
{
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
  • "data": [
    ]
}
Retrieve a Status list configuration
Retrieves an existing Status list configuration by providing its ID.


Analytic events


    

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_START
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_SUCCESS
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_FAIL
    • 



Roles:  ["admin","issuer"]
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Status list configuration ID


 
 Example:  3948c40e-6e19-4ffc-933c-91f643f24264
Responses 
200
Status list configuration 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/configurations/{id}
Request samples 
Response samples 
application/json
{
  • "docType": "DriverLicense",
  • "timeToLiveDuration": {
    },
  • "expiryDuration": {
    }
}
Update a Status list configuration
Updates an existing Status list configuration, allowing you to adjust the expiry and TTL (Time To Live) settings.


Analytic events


    

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_START
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_SUCCESS
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_FAIL
    • 



Roles:  ["admin","issuer"]
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Status list configuration ID


 
 Example:  3948c40e-6e19-4ffc-933c-91f643f24264
Request Body schema: application/json
required
The Status list configuration payload


timeToLiveDuration
object
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
object
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.


 
Responses 
200
Status list configuration updated


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


404
Not Found. The specified resource was not found.


put/v2/credentials/mobile/status-lists/configurations/{id}
Request samples 
application/json
{
  • "timeToLiveDuration": {
    },
  • "expiryDuration": {
    }
}
Response samples 
application/json
{
  • "id": "983c0a86-204f-4431-9371-f5a22e506599",
  • "docType": "Drivers LIcense",
  • "timeToLiveDuration": {
    },
  • "expiryDuration": {
    }
}
Delete a Status list configuration
Permanently deletes an existing Status list configuration.


Analytic events


    

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_START
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_SUCCESS
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_FAIL
    • 



Roles:  ["admin","issuer"]
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Status list configuration ID


 
 Example:  3948c40e-6e19-4ffc-933c-91f643f24264
Responses 
204
Status list configuration deleted


400
Bad request


404
Not Found. The specified resource was not found.


delete/v2/credentials/mobile/status-lists/configurations/{id}
Request samples 
Response samples 
application/json
{
  • "code": "BadRequest",
  • "message": "Status list configuration is in use by at least one status list"
}
➔ Next to Status list retrieval