Revoke a Verifiable Credential

Revoking credentials is crucial for maintaining control over issued credentials and preventing misuse in the cheqd ecosystem. To revoke credentials within the ACA-Py framework, follow these steps:

Step 1: Issuer identifies Credential to be revoked

The Issuer must determine the credential that needs to be revoked by getting the list of issued credentials and the connection id.

Step 2: Revoke Credential

Initiate the credential revocation process by supplying the necessary credential identifiers like the connection id and the credential exchange id.

Revoke an issued credential

POST/anoncreds/revocation/revoke

Body

application/json

commentstring

Optional comment to include in revocation notification

connection_idstring

Connection ID to which the revocation notification will be sent; required if notify is true

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

cred_ex_idstring

Credential exchange identifier

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

cred_rev_idstring

Credential revocation identifier

Example: "12345"

Pattern: ^[1-9][0-9]*$

notifyboolean

Send a notification to the credential recipient

notify_versionenum

Specify which version of the revocation notification should be sent

v1_0v2_0

publishboolean

(True) publish revocation to ledger immediately, or (default, False) mark it pending

rev_reg_idstring

Revocation registry identifier

Example: "did:(method):4:did:<method>:3:CL:20:tag:CL_ACCUM:0"

Pattern: ^(.+$)

thread_idstring

Thread ID of the credential exchange message thread resulting in the credential now being revoked; required if notify is true

Response

200

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/anoncreds/revocation/revoke', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "cred_ex_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "cred_rev_id": "12345",
      "notify_version": "v1_0",
      "rev_reg_id": "did:(method):4:did:<method>:3:CL:20:tag:CL_ACCUM:0"
    }),
});
const data = await response.json();

Response

200

{}

Sample Request Body

{
    "comment": "Revoke issued credential",
    "connection_id": "<issuer--to-holder-conn-id>",
    "cred_ex_id": "<issuer-cred-exchange-id>",
    "notify": true,
    "publish": true
}

Step 3: Verify Revocation

Follow the steps to Present a Verifiable Credential to verify that the credential has been successfully revoked. The response should have verified: false.