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
Request Body schema: application/jsonrequired
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 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. |
Status list configuration created
Bad Request
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "docType": "DriverLicense",
- "timeToLiveDuration": {
- "days": 1
}, - "expiryDuration": {
- "days": 2
}
}
- 201
- 400
{- "id": "983c0a86-204f-4431-9371-f5a22e506599",
- "docType": "Drivers LIcense",
- "timeToLiveDuration": {
- "days": 1
}, - "expiryDuration": {
- "days": 2
}
}
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
Status list configurations retrieved
Bad Request. The request was malformed or missing required parameters.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
{- "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
- "data": [
- {
- "id": "983c0a86-204f-4431-9371-f5a22e506599",
- "docType": "Drivers LIcense",
- "timeToLiveDuration": {
- "days": 1
}, - "expiryDuration": {
- "days": 2
}
}
]
}
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
Status list configuration retrieved
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
- 404
{- "docType": "DriverLicense",
- "timeToLiveDuration": {
- "days": 1
}, - "expiryDuration": {
- "days": 2
}
}
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
path Parameters
Request Body schema: application/jsonrequired
The Status list configuration payload
Status list configuration updated
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "timeToLiveDuration": {
- "days": 1
}, - "expiryDuration": {
- "days": 2
}
}
- 200
- 400
- 404
{- "id": "983c0a86-204f-4431-9371-f5a22e506599",
- "docType": "Drivers LIcense",
- "timeToLiveDuration": {
- "days": 1
}, - "expiryDuration": {
- "days": 2
}
}
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
Status list configuration deleted
Bad request
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 400
- 404
{- "code": "BadRequest",
- "message": "Status list configuration is in use by at least one status list"
}