Sign in
Credentials

Suspend a credential

Temporarily suspend an issued credential. Sets its status to suspended and flips its bit in the tenant's IETF Token Status List so verifiers reject it while suspended. Unlike revocation, suspension is reversible — call the reactivate endpoint to restore the credential. Takes no request body. The credential must belong to the authenticated tenant; otherwise the request returns 404. Requires Authorization: Bearer <tenant API key>.

post/v1/credentials/{uuid}/suspend

Path parameters

uuidstring uuid required

UUID of the issued credential to suspend. Must belong to the authenticated tenant; otherwise the request returns 404.

Response

The credential was suspended. Returns the updated issued-credential record with status suspended.

uuidstring uuid

Unique identifier of the issued credential.

vctstring

Verifiable Credential Type of the credential.

issstring

Issuer identifier (the https iss URL) of the tenant that issued the credential.

status'issued' | 'suspended' | 'revoked' | 'expired'

Lifecycle status after the call; suspended on success.

status_idxinteger nullable

Index of this credential in the tenant's status list, where the suspension bit was just set. Null for non-revocable credentials.

issued_atstring date-time

ISO 8601 timestamp when the credential was issued.

expires_atstring date-time nullable

ISO 8601 timestamp when the credential expires. Null if no expiry.

holder_cnfobject

The holder key-binding confirmation (cnf) object that binds the credential to its holder.

source_session_idstring

Identifier of the Didit verification session this credential was bridged from, or an empty string if none.

Example response

{
  "uuid": "c1d2e3f4-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
  "vct": "https://acme-air.didit.me/credentials/loyalty-membership",
  "iss": "https://acme-air.didit.me",
  "status": "suspended",
  "status_idx": 4213,
  "issued_at": "2026-06-30T12:00:00+00:00",
  "expires_at": "2027-06-30T12:00:00+00:00",
  "holder_cnf": {
    "jwk": {
      "kty": "EC",
      "crv": "P-256",
      "x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
      "y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
    }
  },
  "source_session_id": "11111111-2222-3333-4444-555555555555"
}

Changes