How to revoke a JSON credential
This guide can be used to perform the following common revocation operations:
Prerequisites
- The
id
obtained from the response when you created the credential. Note that this credential must haverevocable
set totrue
.
Revoke a credential
Request
Make a request of the following structure to revoke a JSON credential:
HTTP
POST /v2/credentials/web-semantic/{id}/revocation-status
id
: Replace with theid
of the credential you wish to revoke.
Request body
JSON
{
"isRevoked": true
}
You can make a similar request with isRevoked
set to false
to validate a revoked credential.
Response
JSON
{
"isRevoked": true
}
isRevoked
: Indicates revocation status for the credential. Whentrue
the credential will not be verified as valid.
Revocation lists are cached for a certain amount of time. Updating a revocation status might take some time to reflect in verification workflows.
Retrieve a credential’s revocation status
Request
Make a request of the following structure to retrieve the revocation status of a JSON credential:
HTTP
POST /v2/credentials/web-semantic/{id}/revocation-status
Response
JSON
{
"isRevoked": true
}
isRevoked
: Indicates revocation status for the credential. Whentrue
the credential will not be verified as valid.