Status Lists

Create an unencrypted StatusList2021 or BitstringStatusList credential status list.

post

/credential-status/create/unencrypted

This endpoint creates an unencrypted StatusList2021 or BitstringStatusList credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted.

Authorizations

x-api-keystringRequired

Query parameters

listTypestring · enumRequired

The type of Status List.

Possible values:

statusPurposeone ofRequired

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.

Example: {"summary":"Single purpose (StatusList2021)","value":"revocation"}

string · enumOptionalPossible values:

Body

didstring · uriRequired

DID of the StatusList2021 or BitstringStatusList publisher.

statusListNamestringRequired

The name of the StatusList2021 or BitstringStatusList DID-Linked Resource to be created.

lengthintegerOptional

The length of the status list to be created. The default and minimum length is 131072 which is 16kb.

Default: 131072

encodingstring · enumOptional

The encoding format of the StatusList2021 or BitstringStatusList (only base64url supported) DiD-Linked Resource to be created.

Default: base64urlPossible values:

statusListVersionstringOptional

Optional field to assign a human-readable version in the StatusList2021 or BitstringStatusList DID-Linked Resource.

statusSizeinteger · min: 1Optional

Only for BitstringStatusList: bits per credential, used to support multiple status in same list.

credentialCategorystring · enumOptional

Category of credentials this status list is for.

Possible values:

ttlinteger · min: 1000Optional

Only for BitstringStatusList: Time to Live in Miliseconds (not expiry).

Responses

200

The request was successful.

application/json

createdbooleanOptionalExample: true

resourceMetadataobjectOptionalExample:

{"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}

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

post

/credential-status/create/unencrypted

POST /credential-status/create/unencrypted?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='did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e'&statusListName='cheqd-employee-credentials'&length=140000&encoding='base64url'"

{
  "created": 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
  }
}

Create an encrypted StatusList2021 or BitstringStatusList credential status list.

post

/credential-status/create/encrypted

This endpoint creates an encrypted StatusList2021 or BitstringStatusList credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted.

Authorizations

x-api-keystringRequired

Query parameters

listTypestring · enumRequired

The type of Status List.

Possible values:

statusPurposeone ofRequired

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.

Example: {"summary":"Single purpose (StatusList2021)","value":"revocation"}

string · enumOptionalPossible values:

Body

didstring · uriRequired

DID of the StatusList2021 or BitstringStatusList publisher.

statusListNamestringRequired

The name of the StatusList2021 or BitstringStatusList DID-Linked Resource to be created.

lengthintegerOptional

The length of the status list to be created. The default and minimum length is 131072 which is 16kb.

Default: 131072

encodingstring · enumOptional

The encoding format of the StatusList2021 or BitstringStatusList (only base64url supported) DiD-Linked Resource to be created.

Default: base64urlPossible values:

statusListVersionstringOptional

Optional field to assign a human-readable version in the StatusList2021 or BitstringStatusList DID-Linked Resource.

statusSizeinteger · min: 1Optional

Only for BitstringStatusList: bits per credential, used to support multiple status in same list.

credentialCategorystring · enumOptional

Category of credentials this status list is for.

Possible values:

ttlinteger · min: 1000Optional

Only for BitstringStatusList: Time to Live in Miliseconds (not expiry).

feePaymentAddressstringRequired

The cheqd/Cosmos payment address where payments to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource need to be sent.

Example: cheqd1qs0nhyk868c246defezhz5eymlt0dmajna2csg

feePaymentAmountnumberRequired

Amount in CHEQ tokens to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource.

Default: 20

feePaymentWindownumberRequired

Time window (in minutes) within which the payment to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource is considered valid.

Default: 10

Responses

200

The request was successful.

application/json

createdbooleanOptionalExample: true

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

post

/credential-status/create/encrypted

POST /credential-status/create/encrypted?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: 408

"did='https://example.com'&statusListName='text'&length=131072&encoding='base64url'&statusListVersion='text'&statusSize=1&credentialCategory='credential'&statusMessages=[{'status':'0x0','message':'valid'}]&ttl=1&alsoKnownAs=[{'uri':'https://example.com','description':'text'}]&feePaymentAddress='cheqd1qs0nhyk868c246defezhz5eymlt0dmajna2csg'&feePaymentAmount=20&feePaymentWindow=10"

{
  "created": true,
  "resource": {
    "StatusList2021": {
      "encodedList": "496fdfbeb745b4db03fcdb40566f9c4c4a1c0f184b31255e641b6e7bdfb9b6946c12be87ca3763be0393c00b67ac1e8737c106b32f46ef59c765754415b5e8cc7c65fccaa3374620430ea476301a5e0dd63340e7a27a68bc627518471f22e4a2",
      "type": "StatusList2021Revocation",
      "validFrom": "2023-06-26T11:45:19.349Z"
    },
    "metadata": {
      "type": "StatusList2021Revocation",
      "encoding": "base64url",
      "encrypted": true,
      "encryptedSymmetricKey": "b11182dc524b8181f9a6aef4c4ad0a1c14e40033b9112dffd8d1bcf6cc3b85abc07ded2205ee94068a99f4202502cb0855f322583fa6ce1534d3a05bf36891766ea2c5f90a982b3040680762977d404d758a2370224a239c8279aa7d21e980931c42055b17ca4c7dbffa4782480a8b6279cf989b2f166d5fdb4b2c1b5a63927200000000000000203018dcaba26df45a415bb599218b27ca853a70289d7a3ed3ed0e3730452e8f8d9af91b6e71312565d2c069341f6660ab",
      "paymentConditions": [
        {
          "feePaymentAddress": "cheqd1qs0nhyk868c246defezhz5eymlt0dmajna2csg",
          "feePaymentAmount": "20000000000ncheq",
          "intervalInSeconds": 600,
          "type": "timelockPayment"
        }
      ]
    },
    "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-revocation-encrypted-1",
      "resourceType": "StatusList2021Revocation",
      "mediaType": "application/json",
      "resourceVersion": "2023-06-26T11:45:19.349Z",
      "created": "2023-06-26T11:45:20Z",
      "checksum": "909e22e371a41afbb96c330a97752cf7c8856088f1f937f87decbef06cbe9ca2",
      "previousVersionId": null,
      "nextVersionId": null
    },
    "symmetricKey": "dfe204ee95ae74ea5d74b94c3d8ff782273905b07fbc9f8c3d961c3b43849f18"
  }
}

Update an existing unencrypted StatusList2021 or BitstringStatusList credential status list.

post

/credential-status/update/unencrypted

Authorizations

x-api-keystringRequired

Query parameters

listTypestring · enumRequired

The type of Status List.

Possible values:

statusActionstringRequired

The update action to be performed on the unencrypted status list, can be revoke, suspend, reinstate or custom states

Body

didstring · uriRequired

DID of the StatusList2021 publisher.

statusListNamestringRequired

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

indicesinteger[]Required

List of credential status indices to be updated. The indices must be in the range of the status list.

statusListVersionstringOptional

Optional field to assign a human-readable version in the StatusList2021 DID-Linked Resource.

Responses

200

The request was successful.

application/json

and

anyOptional

and

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

post

/credential-status/update/unencrypted

POST /credential-status/update/unencrypted?listType=StatusList2021&statusAction=text HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 143

"did='did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e'&statusListName='cheqd-employee-credentials'&indices=[10,3199,12109,130999]"

{
  "updated": true,
  "revoked": 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
  }
}

Update an existing encrypted StatusList2021 or BitstringStatusList credential status list.

post

/credential-status/update/encrypted

Authorizations

x-api-keystringRequired

Query parameters

listTypestring · enumRequired

The type of Status List.

Possible values:

statusActionstringRequired

The update action to be performed on the encrypted status list, can be revoke, suspend or reinstate

Body

didstring · uriRequired

DID of the StatusList2021 publisher.

statusListNamestringRequired

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

indicesinteger[]Required

List of credential status indices to be updated. The indices must be in the range of the status list.

statusListVersionstringOptional

Optional field to assign a human-readable version in the StatusList2021 DID-Linked Resource.

symmetricKeystringRequired

The symmetric key used to encrypt the StatusList2021 DID-Linked Resource.

feePaymentAddressstringOptional

The cheqd/Cosmos payment address where payments to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource need to be sent.

Example: cheqd1qs0nhyk868c246defezhz5eymlt0dmajna2csg

feePaymentAmountnumberOptional

Amount in CHEQ tokens to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource.

Default: 20

feePaymentWindownumberOptional

Time window (in minutes) within which the payment to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource is considered valid.

Default: 10

Responses

200

The request was successful.

application/json

and

anyOptional

and

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

post

/credential-status/update/encrypted

POST /credential-status/update/encrypted?listType=StatusList2021&statusAction=text HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 227

"did='https://example.com'&statusListName='text'&indices=[1]&statusListVersion='text'&symmetricKey='text'&feePaymentAddress='cheqd1qs0nhyk868c246defezhz5eymlt0dmajna2csg'&feePaymentAmount=20&feePaymentWindow=10"

{
  "updated": true,
  "revoked": true,
  "resource": {
    "StatusList2021": {
      "encodedList": "496fdfbeb745b4db03fcdb40566f9c4c4a1c0f184b31255e641b6e7bdfb9b6946c12be87ca3763be0393c00b67ac1e8737c106b32f46ef59c765754415b5e8cc7c65fccaa3374620430ea476301a5e0dd63340e7a27a68bc627518471f22e4a2",
      "type": "StatusList2021Revocation",
      "validFrom": "2023-06-26T11:45:19.349Z"
    },
    "metadata": {
      "type": "StatusList2021Revocation",
      "encoding": "base64url",
      "encrypted": true,
      "encryptedSymmetricKey": "b11182dc524b8181f9a6aef4c4ad0a1c14e40033b9112dffd8d1bcf6cc3b85abc07ded2205ee94068a99f4202502cb0855f322583fa6ce1534d3a05bf36891766ea2c5f90a982b3040680762977d404d758a2370224a239c8279aa7d21e980931c42055b17ca4c7dbffa4782480a8b6279cf989b2f166d5fdb4b2c1b5a63927200000000000000203018dcaba26df45a415bb599218b27ca853a70289d7a3ed3ed0e3730452e8f8d9af91b6e71312565d2c069341f6660ab",
      "paymentConditions": [
        {
          "feePaymentAddress": "cheqd1qs0nhyk868c246defezhz5eymlt0dmajna2csg",
          "feePaymentAmount": "20000000000ncheq",
          "intervalInSeconds": 600,
          "type": "timelockPayment"
        }
      ]
    },
    "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-revocation-encrypted-1",
      "resourceType": "StatusList2021Revocation",
      "mediaType": "application/json",
      "resourceVersion": "2023-06-26T11:45:19.349Z",
      "created": "2023-06-26T11:45:20Z",
      "checksum": "909e22e371a41afbb96c330a97752cf7c8856088f1f937f87decbef06cbe9ca2",
      "previousVersionId": null,
      "nextVersionId": null
    },
    "symmetricKey": "dfe204ee95ae74ea5d74b94c3d8ff782273905b07fbc9f8c3d961c3b43849f18"
  }
}

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.

indexintegerOptional

Credential status index to be checked for revocation or suspension.

indicesinteger[]Optional

List of credential status indices to be checked for revocation or suspension.

indexRangeStartintegerOptional

Start of the credential status index range to be checked for revocation or suspension.

indexRangeEndintegerOptional

End of the credential status index range 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

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

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: 201

"did='https://example.com'&statusListName='text'&index=1&indices=[1]&indexRangeStart=1&indexRangeEnd=1&statusListCredential='text'&statusSize=2&statusMessage=[]&makeFeePayment=true"

{
  "checked": true,
  "revoked": false
}

Fetch StatusList2021 or BitstringStatusList DID-Linked Resource based on search criteria.

get

/credential-status/search

Authorizations

x-api-keystringRequired

Query parameters

didstringRequired

The DID of the issuer of the status list.

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:

statusListNamestringRequired

The name of the Status List DID-Linked Resource.

Responses

200

The request was successful.

application/json

and

anyOptional

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

get

/credential-status/search

GET /credential-status/search?did=text&listType=StatusList2021&statusPurpose=revocation&statusListName=text HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Accept: */*

{
  "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
  }
}

List StatusList2021 or BitstringStatusList DID-Linked Resources created by the customer.

get

/credential-status/list

Authorizations

x-api-keystringRequired

Query parameters

didstringOptional

The DID of the issuer of the status list.

listTypestring · enumOptional

The type of Status List.

Possible values:

statusListNamestringOptional

The name of the Status List DID-Linked Resource.

statestring · enumOptional

The state of the Status List DID-Linked Resource.

Possible values:

credentialCategorystring · enumOptional

Filter status lists by credential category assigned for.

Possible values:

deprecatedbooleanOptional

Filter status lists by deprecated status.

Responses

200

The request was successful.

application/json

totalnumberOptional

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

get

/credential-status/list

GET /credential-status/list HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Accept: */*

{
  "total": 1,
  "records": [
    {
      "statusListId": "5945233a-a4b5-422b-b893-eaed5cedd2dc",
      "statusListName": "cheqd-employee-credentials",
      "uri": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-employee-credentials&resourceType=StatusList2021Revocation",
      "issuerId": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e",
      "previousUri": null,
      "nextUri": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-employee-credentials-ext1&resourceType=StatusList2021Revocation",
      "listType": "StatusList2021Revocation",
      "storageType": "cheqd",
      "encrypted": false,
      "credentialCategory": "credential",
      "size": 131072,
      "writeCursor": 105432,
      "state": "ACTIVE",
      "createdAt": "2023-06-26T11:45:19.349Z",
      "updatedAt": "2023-06-26T11:45:20.000Z",
      "sealedAt": null,
      "deprecated": false
    }
  ]
}

Fetch StatusList2021 or BitstringStatusList DID-Linked Resource based on search criteria.

get

/credential-status/list/{statusListId}

Authorizations

x-api-keystringRequired

Path parameters

statusListIdstringRequired

The statusListId of the status list.

Responses

200

The request was successful.

application/json

statusListIdstringOptional

Unique identifier for the status registry

statusListNamestringOptional

Name of the status list resource

uristringOptional

DID URL of the status list resource

issuerIdstring · uriOptional

DID of the issuer

previousUristring · nullableOptional

Link to previous registry in the chain (for FULL registries)

nextUristring · nullableOptional

Link to next registry in the chain (STANDBY registry)

listTypestringOptional

Type of status list (StatusList2021Revocation, StatusList2021Suspension, BitstringStatusListCredential)

storageTypestring · enumOptional

Storage provider for the status list

Possible values:

encryptedbooleanOptional

Whether the status list is encrypted

credentialCategorystring · enumOptional

Category of credentials this status list is for

Possible values:

sizeintegerOptional

Maximum capacity of the status list (total number of indices)

writeCursorintegerOptional

Current write cursor position (last assigned index)

statestring · enumOptional

Current state of the registry

Possible values:

createdAtstring · date-timeOptional

Timestamp when the registry was created

updatedAtstring · date-timeOptional

Timestamp when the registry was last updated

sealedAtstring · date-time · nullableOptional

Timestamp when the registry was sealed (marked as FULL)

statusPurposeone ofOptional

Status purpose or list of status purposes

stringOptional

string[]Optional

deprecatedbooleanOptional

Whether the registry is deprecated

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

get

/credential-status/list/{statusListId}

GET /credential-status/list/{statusListId} HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusListId": "5945233a-a4b5-422b-b893-eaed5cedd2dc",
  "statusListName": "cheqd-employee-credentials",
  "uri": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-employee-credentials&resourceType=StatusList2021Revocation",
  "issuerId": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e",
  "previousUri": null,
  "nextUri": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-employee-credentials-ext1&resourceType=StatusList2021Revocation",
  "listType": "StatusList2021Revocation",
  "storageType": "cheqd",
  "encrypted": false,
  "credentialCategory": "credential",
  "size": 131072,
  "writeCursor": 105432,
  "state": "ACTIVE",
  "createdAt": "2023-06-26T11:45:19.349Z",
  "updatedAt": "2023-06-26T11:45:20.000Z",
  "statusPurpose": [
    "revocation"
  ],
  "sealedAt": null,
  "deprecated": false
}

Last updated 1 month ago

Was this helpful?

hashtagCreate an unencrypted StatusList2021 or BitstringStatusList credential status list.

hashtagCreate an encrypted StatusList2021 or BitstringStatusList credential status list.

hashtagUpdate an existing unencrypted StatusList2021 or BitstringStatusList credential status list.

hashtagUpdate an existing encrypted StatusList2021 or BitstringStatusList credential status list.

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

hashtagFetch StatusList2021 or BitstringStatusList DID-Linked Resource based on search criteria.

hashtagList StatusList2021 or BitstringStatusList DID-Linked Resources created by the customer.

hashtagFetch StatusList2021 or BitstringStatusList DID-Linked Resource based on search criteria.

Create an unencrypted StatusList2021 or BitstringStatusList credential status list.

Create an encrypted StatusList2021 or BitstringStatusList credential status list.

Update an existing unencrypted StatusList2021 or BitstringStatusList credential status list.

Update an existing encrypted StatusList2021 or BitstringStatusList credential status list.

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

Fetch StatusList2021 or BitstringStatusList DID-Linked Resource based on search criteria.

List StatusList2021 or BitstringStatusList DID-Linked Resources created by the customer.

Fetch StatusList2021 or BitstringStatusList DID-Linked Resource based on search criteria.