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 empty
content-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 
Usage
cURL
curl --location \
	--request POST \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	'{registry-url}/api/v1/{entity-type}/{id}/revoke' \
​
​
HTTPie
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 the registry section in the docker-compose.yml file and is usually 8081.

Update A Property Of An Entity

Delete An Entity

Last modified 1mo ago