Modifying credential's status

Edit online

To modify the status of an issued credential, use the PATCH /v1.0/diagency/credentials/{id}/status endpoint. This endpoint enables the issuer to change the status of a credential for a specified purpose. Only the original issuer is authorized to perform this action.

In the request body:
  • statusPurpose defines the type of status to modify. This value must have been configured to be an enabled status purpose during the initial creation of the credential definition.
  • status is an integer value that indicates the new status.

For example, if a credential was issued with a statusPurpose of revocation, the issuer can later choose to revoke the credential by using this endpoint. After revocation, any attempts to present the credential fail due to its new revoked status.

If there is an active DIDComm connection between the issuer and the holder, a message is sent to the holder to notify them of the status update.

This endpoint has no return body. It returns a 204 status code upon successful execution.