Suspend credential

POST

/api/admin/vc/credentials/{id}/suspend

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/vc/credentials/example/suspend \
  --header 'Authorization: Bearer <token>'

Temporarily suspends an active credential using the status list associated with the credential.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Responses

200

Credential status update result.

Media type application/json

object

id

required

string

status

required

string

Allowed values: active suspended revoked

status_list_id

required

string

status_list_index

required

integer

revoked_at

string format: date-time

suspended_at

string format: date-time

activated_at

string format: date-time

key

additional properties

Example

{
  "id": "cred_123",
  "status": "revoked",
  "status_list_id": "sl_revocation_1",
  "status_list_index": 42,
  "revoked_at": "2026-06-01T00:00:00.000Z"
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}