Update Status List v2021

Update indices in Status List

The /credential-status/update/unencrypted API enables users to update the indices of a Status List. This may be useful for revoking Credentials in bulk, rather than submitting individual /credential/revoke requests.

Update an existing unencrypted StatusList2021 credential status list.

post

/credential-status/update/unencrypted

Authorizations

Query parameters

statusActionstring · enumrequired

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

Options: revoke, suspend, reinstate

Body

application/x-www-form-urlencodedapplication/json

didstring · urirequired

DID of the StatusList2021 publisher.

statusListNamestringrequired

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

statusListVersionstring

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

indicesinteger[]required

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/credential-status/update/unencrypted?statusAction=revoke' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"did":"did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e","statusListName":"cheqd-employee-credentials","indices":[10,3199,12109,130999]}'

200

400

401

500

200

{
  "updated": true,
  "revoked": true,
  "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
  },
  "resource": {
    "StatusList2021": {
      "encodedList": "H4sIAAAAAAAAA-3BAQ0AAADCoPdPbQ8HFAAAAAAAAAAAAAAAAAAAAADwaDhDr_xcRAAA",
      "type": "StatusList2021Revocation",
      "validFrom": "2023-06-26T11:45:19.349Z"
    },
    "metadata": {
      "type": "StatusList2021Revocation",
      "encoding": "base64url",
      "encrypted": false
    }
  }
}

The request was successful.