Skip to main content

DELETE /credentials/:credentialId

Revoke a Verifiable Credential.

{{baseUrl}}/credentials/:credentialId

Headers

HeaderTypeDescription
x-api-keystringThe API key required for authentication.

Path Parameters

ParameterTypeDescription
credentialIdstringThe unique identifier of the Verifiable Credential to be revoked.
credentialId: DegreeCredential-35f5d2f5-b272-4563-a4b8-cd08608896ea

Click Send and wait for the response.

Response (Success - 200)

ParameterTypeDescription
messagestringA message confirming that the Verifiable Credential was deleted.
credentialIdstringThe ID of the Verifiable Credential that was deleted.

Sample Response Body:

{
"message": "Credential with ID DegreeCredential-35f5d2f5-b272-4563-a4b8-cd08608896ea has been successfully deleted.",
"credentialId": "DegreeCredential-35f5d2f5-b272-4563-a4b8-cd08608896ea"
}

Response (Server Error - 500)

ParameterTypeDescription
errorstringDescribes the error that occurred.

Sample Response Body:

{
"error": "Server error"
}