Proofs

Suspend proof

Reversibly pause a proof (m-proof-status-list). A suspended proof answers invalid on validation and carries status-list bit 2, but unlike revocation the owner can lift it with the unsuspend endpoint. Only an active proof can be suspended. Accepts a public proof handle (ph_ctl_<32 hex> or ph_dlg_<32 hex>) or a verification id — the same addresses the status and revoke routes take. Reachable with an API key (proofs:write) or a dashboard session cookie; the scope binds API-key callers only. Suspending a DELEGATION handle (ph_dlg_*) additionally requires delegations:write, exactly as revoking one does: while the pause holds, every verifier rejects that delegation, which is what a revocation produces, and reversibility bounds the cost of restoring it rather than the reach of the act.

post/api/v1/proofs/{id}/suspend

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/proofs/{id}/suspend
  • Auth: one of:
    • HTTP bearer
    • API key in cookie auth_token

Path parameters

idstring required

Public proof handle (ph_ctl_<32 hex> for a domain control proof, ph_dlg_<32 hex> for a delegation) or verification id

Example:ph_ctl_0123456789abcdef0123456789abcdef

Response

Proof suspended

proof_idstring required

Public proof handle (ph_ctl_<32 hex>)

status'suspended' | 'active' required

suspended after a suspend, active after an unsuspend

suspended_atstring date-time nullable required

When the suspension began; null after an unsuspend

status_list_uristring required

The Token Status List where this change is published

Example response

{
  "proof_id": "ph_ctl_0123456789abcdef0123456789abcdef",
  "status": "suspended",
  "status_list_uri": "https://api.proof.holdings/api/v1/proofs/status-list"
}

Changes

No recorded changes to this operation across all 1 revision of this API.