Search Status List

The /credential-status/search API allows users to search for specific entries of a Status List on the cheqd network. For example, if there are multiple Status Lists associated with the same DID, the search functionality allows applications to make requests only to a specified Status List. 
Step 1: Set Status List Search Filters
Users are able to filter by:
did (required)
The is the DID of the publisher of the Status List. The Status List entries will be DID-Linked Resources associated with this DID.
statusPurpose
The is the type of Status List to be queried. The options are:
revocation
suspension
statusListName
The is the name of the Status List. Alongside the statusPurpose, this will uniquely identify a version of the Status List.
Step 2: Hit the API
Execute the filters from Step 1 on the API below:
get
/credential-status/search
Fetch StatusList2021 DID-Linked Resource based on search criteria.
Parameters
Query
did*
string
The DID of the issuer of the status list.
statusPurpose
string
The purpose of the status list. Can be either revocation or suspension.
statusListName
string
The name of the StatusList2021 DID-Linked Resource.
Responses
200: OK
The request was successful.
400: Bad Request
A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.
401: Unauthorized
Access token is missing or invalid
500: Internal Server Error
An internal error has occurred. Additional state information plus metadata may be available in the response body.

Last modified 24d ago