cheqd StudioSupport / Bug Reports

Verify a Status List

Verify an unencrypted Status List using cheqd Studio.

Check a StatusList2021 or BitstringStatusList index for a given Verifiable Credential.

post
/credential-status/check

This endpoint checks a StatusList2021 or BitstringStatusList index for a given Verifiable Credential and reports whether it is revoked or suspended. It offers a standalone method for checking an index without passing the entire Verifiable Credential or Verifiable Presentation.

Authorizations
x-api-keystringRequired
Query parameters
listTypestring · enumRequired

The type of Status List.

Possible values:
statusPurposestring · enumRequired

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

Possible values:
Body
didstring · uriRequired

DID of the StatusList2021 publisher.

statusListNamestringRequired

The name of the StatusList2021 DID-Linked Resource to be checked.

indexintegerRequired

Credential status index to be checked for revocation or suspension.

statusListCredentialstringOptional

Optional Resolvable DID URL of the BitstringStatusList credential to be checked.

statusSizenumberOptional

Optional size of the BitstringStatusList.

Default: 2
statusMessagearrayOptional

Array of status messages for each bit in the BitstringStatusList.

makeFeePaymentbooleanOptional

Automatically make fee payment (if required) based on payment conditions to unlock encrypted StatusList2021 or BitstringStatusList DID-Linked Resource.

Default: true
Responses
200

The request was successful.

application/json
Responseone of
or
post
/credential-status/check
POST /credential-status/check?listType=StatusList2021&statusPurpose=revocation HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 149

"did='https://example.com'&statusListName='text'&index=1&statusListCredential='text'&statusSize=2&statusMessage=[]&makeFeePayment=true"
{
  "checked": true,
  "revoked": false
}

Last updated

Was this helpful?