Status Lists
Create an unencrypted StatusList2021 or BitstringStatusList credential status list.
The type of Status List.
The purpose of the status list.
- For StatusList2021: Single value (revocation or suspension)
- For BitstringStatusList: Can accept multiple values as array of strings
Once this is set, it cannot be changed. A new status list must be created to change the purpose.
{"summary":"Single purpose (StatusList2021)","value":"revocation"}The request was successful.
A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.
Access token is missing or invalid
An internal error has occurred. Additional state information plus metadata may be available in the response body.
Create an encrypted StatusList2021 or BitstringStatusList credential status list.
The type of Status List.
The purpose of the status list.
- For StatusList2021: Single value (revocation or suspension)
- For BitstringStatusList: Can accept multiple values as array of strings
Once this is set, it cannot be changed. A new status list must be created to change the purpose.
{"summary":"Single purpose (StatusList2021)","value":"revocation"}The request was successful.
A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.
Access token is missing or invalid
An internal error has occurred. Additional state information plus metadata may be available in the response body.
Update an existing unencrypted StatusList2021 or BitstringStatusList credential status list.
The type of Status List.
The update action to be performed on the unencrypted status list, can be revoke, suspend, reinstate or custom states
The request was successful.
A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.
Access token is missing or invalid
An internal error has occurred. Additional state information plus metadata may be available in the response body.
Update an existing encrypted StatusList2021 or BitstringStatusList credential status list.
The type of Status List.
The update action to be performed on the encrypted status list, can be revoke, suspend or reinstate
The request was successful.
A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.
Access token is missing or invalid
An internal error has occurred. Additional state information plus metadata may be available in the response body.
Check a StatusList2021 or BitstringStatusList index for a given Verifiable Credential.
The type of Status List.
The purpose of the status list. Can be either revocation or suspension.
DID of the StatusList2021 publisher.
The name of the StatusList2021 DID-Linked Resource to be checked.
Credential status index to be checked for revocation or suspension.
List of credential status indices to be checked for revocation or suspension.
Start of the credential status index range to be checked for revocation or suspension.
End of the credential status index range to be checked for revocation or suspension.
Optional Resolvable DID URL of the BitstringStatusList credential to be checked.
Optional size of the BitstringStatusList.
2Array of status messages for each bit in the BitstringStatusList.
Automatically make fee payment (if required) based on payment conditions to unlock encrypted StatusList2021 or BitstringStatusList DID-Linked Resource.
trueThe request was successful.
A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.
Access token is missing or invalid
An internal error has occurred. Additional state information plus metadata may be available in the response body.
Fetch StatusList2021 or BitstringStatusList DID-Linked Resource based on search criteria.
The DID of the issuer of the status list.
The type of Status List.
The purpose of the status list. Can be either revocation or suspension.
The name of the Status List DID-Linked Resource.
The request was successful.
A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.
Access token is missing or invalid
An internal error has occurred. Additional state information plus metadata may be available in the response body.
List StatusList2021 or BitstringStatusList DID-Linked Resources created by the customer.
The DID of the issuer of the status list.
The type of Status List.
The name of the Status List DID-Linked Resource.
The state of the Status List DID-Linked Resource.
Filter status lists by credential category assigned for.
Filter status lists by deprecated status.
The request was successful.
A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.
Access token is missing or invalid
An internal error has occurred. Additional state information plus metadata may be available in the response body.
Fetch StatusList2021 or BitstringStatusList DID-Linked Resource based on search criteria.
The statusListId of the status list.
The request was successful.
Unique identifier for the status registry
Name of the status list resource
DID URL of the status list resource
DID of the issuer
Link to previous registry in the chain (for FULL registries)
Link to next registry in the chain (STANDBY registry)
Type of status list (StatusList2021Revocation, StatusList2021Suspension, BitstringStatusListCredential)
Storage provider for the status list
Whether the status list is encrypted
Category of credentials this status list is for
Maximum capacity of the status list (total number of indices)
Current write cursor position (last assigned index)
Current state of the registry
Timestamp when the registry was created
Timestamp when the registry was last updated
Timestamp when the registry was sealed (marked as FULL)
Status purpose or list of status purposes
Whether the registry is deprecated
A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.
Access token is missing or invalid
An internal error has occurred. Additional state information plus metadata may be available in the response body.
Last updated
Was this helpful?