1 of 1

Search Status List v2021

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:

Search Status List v2021

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:

Fetch StatusList2021 DID-Linked Resource based on search criteria.

GET/credential-status/search

Query parameters

did*string

The DID of the issuer of the status list.

statusPurposeenum

The purpose of the status list. Can be either revocation or suspension.

revocationsuspension

statusListNamestring

The name of the StatusList2021 DID-Linked Resource.

Response

The request was successful.

Body

foundboolean

Example: true

one of

resourceobject

StatusList2021object

encodedListstring

Example: "H4sIAAAAAAAAA-3BAQ0AAADCoPdPbQ8HFAAAAAAAAAAAAAAAAAAAAADwaDhDr_xcRAAA"

typestring

Example: "StatusList2021Revocation"

validFromstring (date-time)

Example: "2023-06-26T11:45:19.349Z"

metadataobject

typestring

Example: "StatusList2021Revocation"

encodingstring

Example: "base64url"

encryptedboolean

Example: false

resourceMetadataobject

Request

Response

Fetch StatusList2021 DID-Linked Resource based on search criteria.

GET/credential-status/search

Query parameters

did*string

The DID of the issuer of the status list.

statusPurposeenum

The purpose of the status list. Can be either revocation or suspension.

revocationsuspension

statusListNamestring

The name of the StatusList2021 DID-Linked Resource.

Response

The request was successful.

Body

foundboolean

Example: true

one of

resourceobject

StatusList2021object

encodedListstring

Example: "H4sIAAAAAAAAA-3BAQ0AAADCoPdPbQ8HFAAAAAAAAAAAAAAAAAAAAADwaDhDr_xcRAAA"

typestring

Example: "StatusList2021Revocation"

validFromstring (date-time)

Example: "2023-06-26T11:45:19.349Z"

metadataobject

typestring

Example: "StatusList2021Revocation"

encodingstring

Example: "base64url"

encryptedboolean

Example: false

resourceMetadataobject

Request

Response

const response = await fetch('/credential-status/search?did=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "found": true,
  "resource": {
    "StatusList2021": {
      "encodedList": "H4sIAAAAAAAAA-3BAQ0AAADCoPdPbQ8HFAAAAAAAAAAAAAAAAAAAAADwaDhDr_xcRAAA",
      "type": "StatusList2021Revocation",
      "validFrom": "2023-06-26T11:45:19.349Z"
    },
    "metadata": {
      "type": "StatusList2021Revocation",
      "encoding": "base64url",
      "encrypted": false
    }
  },
  "resourceMetadata": {
    "resourceURI": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e/resources/5945233a-a4b5-422b-b893-eaed5cedd2dc",
    "resourceCollectionId": "7c2b990c-3d05-4ebf-91af-f4f4d0091d2e",
    "resourceId": "5945233a-a4b5-422b-b893-eaed5cedd2dc",
    "resourceName": "cheqd-employee-credentials",
    "resourceType": "StatusList2021Revocation",
    "mediaType": "application/json",
    "resourceVersion": "1.0.0",
    "created": "2023-06-26T11:45:20Z",
    "checksum": "909e22e371a41afbb96c330a97752cf7c8856088f1f937f87decbef06cbe9ca2",
    "previousVersionId": null,
    "nextVersionId": null
  }
}