1 of 1

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 Status List v2021

Update indices in Status List

Update an existing unencrypted StatusList2021 credential status list.

POST/credential-status/update/unencrypted

Query parameters

statusAction*enum

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

revokesuspendreinstate

Body

did*string (uri)

DID of the StatusList2021 publisher.

statusListName*string

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

indices*array of integer

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

itemsinteger

statusListVersionstring

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

Response

The request was successful.

Body

updatedboolean

Example: true

one of

revokedboolean

Example: true

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

Update an existing unencrypted StatusList2021 credential status list.

POST/credential-status/update/unencrypted

Query parameters

statusAction*enum

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

revokesuspendreinstate

Body

did*string (uri)

DID of the StatusList2021 publisher.

statusListName*string

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

indices*array of integer

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

itemsinteger

statusListVersionstring

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

Response

The request was successful.

Body

updatedboolean

Example: true

one of

revokedboolean

Example: true

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/update/unencrypted?statusAction=revoke', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "did": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e",
      "statusListName": "cheqd-employee-credentials",
      "indices": [
        10,
        3199,
        12109,
        130999
      ]
    }),
});
const data = await response.json();

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