1 of 1

Bulk Update or Rotate Encryption Keys

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

When a new encrypted Status List resource is published, this will also encrypt the latest version with a new set of encryption keys. This may therefore be used to rotate encryption keys, even if the listed indices are kept the same.

Bulk Update or Rotate Encryption Keys

Update an existing encrypted StatusList2021 credential status list.

POST/credential-status/update/encrypted

Query parameters

statusAction*enum

The update action to be performed on the encrypted 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.

symmetricKey*string

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

feePaymentAddressstring

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

Example: "cheqd1qs0nhyk868c246defezhz5eymlt0dmajna2csg"

feePaymentAmountnumber

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

feePaymentWindownumber

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

Response

The request was successful.

Body

updatedboolean

Example: true

one of

revokedboolean

Example: true

resourceobject

StatusList2021object

encodedListstring

Example:

"496fdfbeb745b4db03fcdb40566f9c4c4a1c0f184b31255e641b6e7bdfb9b6946c12be87ca3763be0393c00b67ac1e8737c106b32f46ef59c765754415b5e8cc7c65fccaa3374620430ea476301a5e0dd63340e7a27a68bc627518471f22e4a2"

typestring

Example: "StatusList2021Revocation"

validFromstring (date-time)

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

metadataobject

typestring

Example: "StatusList2021Revocation"

encodingstring

Example: "base64url"

encryptedboolean

Example: true

encryptedSymmetricKeystring

Example:

"b11182dc524b8181f9a6aef4c4ad0a1c14e40033b9112dffd8d1bcf6cc3b85abc07ded2205ee94068a99f4202502cb0855f322583fa6ce1534d3a05bf36891766ea2c5f90a982b3040680762977d404d758a2370224a239c8279aa7d21e980931c42055b17ca4c7dbffa4782480a8b6279cf989b2f166d5fdb4b2c1b5a63927200000000000000203018dcaba26df45a415bb599218b27ca853a70289d7a3ed3ed0e3730452e8f8d9af91b6e71312565d2c069341f6660ab"

paymentConditionsarray of object

feePaymentAddressstring

Example: "cheqd1qs0nhyk868c246defezhz5eymlt0dmajna2csg"

feePaymentAmountstring

Example: "20000000000ncheq"

intervalInSecondsnumber

Example: 600

typestring

Example: "timelockPayment"

resourceMetadataobject

symmetricKeystring

Example: "dfe204ee95ae74ea5d74b94c3d8ff782273905b07fbc9f8c3d961c3b43849f18"

Request

Response

Update an existing encrypted StatusList2021 credential status list.

POST/credential-status/update/encrypted

Query parameters

statusAction*enum

The update action to be performed on the encrypted 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.

symmetricKey*string

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

feePaymentAddressstring

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

Example: "cheqd1qs0nhyk868c246defezhz5eymlt0dmajna2csg"

feePaymentAmountnumber

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

feePaymentWindownumber

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

Response

The request was successful.

Body

updatedboolean

Example: true

one of

revokedboolean

Example: true

resourceobject

StatusList2021object

encodedListstring

Example:

"496fdfbeb745b4db03fcdb40566f9c4c4a1c0f184b31255e641b6e7bdfb9b6946c12be87ca3763be0393c00b67ac1e8737c106b32f46ef59c765754415b5e8cc7c65fccaa3374620430ea476301a5e0dd63340e7a27a68bc627518471f22e4a2"

typestring

Example: "StatusList2021Revocation"

validFromstring (date-time)

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

metadataobject

typestring

Example: "StatusList2021Revocation"

encodingstring

Example: "base64url"

encryptedboolean

Example: true

encryptedSymmetricKeystring

Example:

"b11182dc524b8181f9a6aef4c4ad0a1c14e40033b9112dffd8d1bcf6cc3b85abc07ded2205ee94068a99f4202502cb0855f322583fa6ce1534d3a05bf36891766ea2c5f90a982b3040680762977d404d758a2370224a239c8279aa7d21e980931c42055b17ca4c7dbffa4782480a8b6279cf989b2f166d5fdb4b2c1b5a63927200000000000000203018dcaba26df45a415bb599218b27ca853a70289d7a3ed3ed0e3730452e8f8d9af91b6e71312565d2c069341f6660ab"

paymentConditionsarray of object

feePaymentAddressstring

Example: "cheqd1qs0nhyk868c246defezhz5eymlt0dmajna2csg"

feePaymentAmountstring

Example: "20000000000ncheq"

intervalInSecondsnumber

Example: 600

typestring

Example: "timelockPayment"

resourceMetadataobject

symmetricKeystring

Example: "dfe204ee95ae74ea5d74b94c3d8ff782273905b07fbc9f8c3d961c3b43849f18"

Request

Response

const response = await fetch('/credential-status/update/encrypted?statusAction=revoke', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "did": "https://example.com",
      "statusListName": "text",
      "indices": [
        0
      ],
      "symmetricKey": "text"
    }),
});
const data = await response.json();

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