Skip to main content
DELETE
/
credential
/
revoke
/
{credentialId}
Revoke Credential
curl --request DELETE \
  --url https://api.example.com/credential/revoke/{credentialId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "user_initiated"
}
'
{
  "credentialId": "urn:via:credential:550e8400-e29b-41d4-a716-446655440000",
  "status": "REVOKED",
  "revokedAt": "2026-05-02T10:15:30.000Z",
  "receipt": {
    "id": "urn:via:receipt:c4bb2c9d-9b37-448b-8f1a-4ac5793945be",
    "timestamp": "2026-05-02T10:15:30.000Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://humanos.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
API-Version
string

Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today's date.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-03-03"

Path Parameters

​
credentialId
string
required

URN of the credential to revoke

Example:

"urn:via:credential:550e8400-e29b-41d4-a716-446655440000"

Body

application/json
​
reason
string

Free-text reason for revocation, recorded on the credential and in the MANDATE_REVOKED receipt. Recommended values from VIA protocol §5.5.1: "user_initiated", "organization_policy", "system_expiry".

Maximum string length: 200
Example:

"user_initiated"

Response

Credential revoked. Returns the MANDATE_REVOKED receipt.

​
credentialId
string
required

URN of the revoked credential

Example:

"urn:via:credential:550e8400-e29b-41d4-a716-446655440000"

​
status
enum<string>
required

Always REVOKED on a successful response

Available options:
DRAFT,
ACTIVE,
REJECTED,
CANCELED,
REVOKED,
EXPIRED
Example:

"REVOKED"

​
revokedAt
string
required

When the credential was revoked (ISO 8601)

Example:

"2026-05-02T10:15:30.000Z"

​
receipt
object
required

MANDATE_REVOKED receipt issued for this revocation