Comment on page
Revoke a Credential
To revoke an existing VC (Verifiable Credential) or an entity, we need to make the following HTTP request
post
/api/v1/{entity-type}/{id}/revoke
This revokes an existing verifiable credential
The API revokes a verifiable credential by updating the signature data attached to it. This is done by updating the _osSignedData field in the corresponding entity table to an Empty String. and storing the signedData in the RevokedCredential Registry.
Parameters
Path
entity-type*
Type of entity to update
id*
id of the entity to revoke
Header
authorization
Set to
Bearer {access-token}
if roles in Schema is not anonymous. Else token can be emptycontent-type*
Set to
application/json
Body
Responses
200: OK
Entity is Succesfully revoked
401: Unauthorized
Issue in the token authentication - unauthorised
500: Internal Server Error
Credential is already revoked
curl --location \
--request POST \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
'{registry-url}/api/v1/{entity-type}/{id}/revoke' \
http POST \
'{registry_url}/api/v1/{entity-type}/{id}/revoke' \
'content-type: application/json' \
'authorization: Bearer {access-token}'
{registry-url}
is usually http://localhost:{port}. The port can be found under theregistry
section in thedocker-compose.yml
file and is usually8081
.
Last modified 1mo ago