Skip to main content
POST
/
v1
/
credentials
/
{id}
/
revoke
Revoke a credential
curl --request POST \
  --url https://api.example.com/v1/credentials/{id}/revoke \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'
{
  "subject": {
    "id": "<string>",
    "registration_number": "<string>",
    "jurisdiction": "<string>",
    "legal_form": "<string>"
  },
  "claims": {
    "registered_address": {
      "line1": "<string>",
      "city": "<string>",
      "country": "<string>",
      "line2": "<string>",
      "state_or_region": "<string>",
      "postal_code": "<string>"
    },
    "beneficial_owners": [
      {
        "full_name": "<string>",
        "ownership_percent": 50,
        "person_id": "<string>",
        "role": "<string>"
      }
    ],
    "tax_id_verified": true,
    "jurisdiction": "<string>"
  },
  "id": "<string>",
  "credential_id": "<string>",
  "issuer_did": "<string>",
  "status_list_index": 1,
  "kid": "<string>",
  "signed_payload": "<string>",
  "evidence_refs": [
    "<string>"
  ],
  "issued_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "vct": "<string>",
  "revoked_at": "2023-11-07T05:31:56Z",
  "revocation_reason": "<string>",
  "created_via": "api",
  "developer_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.beltic.com/llms.txt

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

Path Parameters

​
id
string
required
Example:

"cred_abc123"

Body

application/json
​
reason
string

Response

Credential revoked

​
credential_type
enum<string>
required
Available options:
business
​
subject
object
required
​
claims
object
required
​
id
string
required
​
credential_id
string
required
​
issuer_did
string
required
​
status
enum<string>
required
Available options:
active,
revoked,
expired,
suspended
​
status_list_index
integer
required
Required range: x >= 0
​
proof_format
enum<string>
required
Available options:
jwt_vc,
sd_jwt_vc
​
alg
enum<string>
required
Available options:
ES256
​
kid
string
required
​
signed_payload
string
required
​
evidence_refs
string[]
required
Maximum array length: 50
Required string length: 1 - 512
​
issued_at
string<date-time>
required
​
expires_at
string<date-time>
required
​
vct
string
​
revoked_at
string<date-time> | null
​
revocation_reason
string | null
​
created_via
enum<string>
default:api
Available options:
batch_mint,
workflow_block,
api,
cli,
mcp
​
developer_id
string