Block an identification

Suspends an identification and blocks all associated services for every account linked to it. This is the escalation endpoint for when an end user must be stopped immediately (e.g. suspected fraud). A vault-scoped variant is also available at POST /vaults/{vault_id}/identifications/{identification_id}/block.
Blocked services are: - trades - fiat_payment - blockchain_payment - card_payment - internal_settlement (only when the feature is enabled for the vault)
Effects: - The identification status is set to blocked. - Each affected account fires an account_locked webhook, so the client is notified. - When a reason is provided, it is stored on every blocked service for auditability, and the
block is attributed to the API caller (blocked_by).

Idempotent: blocking an identification that is already blocked succeeds and returns the current state. This endpoint never unblocks anything.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The UUID of the identification to block

Body Params
string
enum

Reason for the block. Restricted to the allowed lock reasons: - fraud: suspected fraudulent activity - closure: closed at the customer's request - manual: manual block decided by operations
If omitted, the block is recorded without a reason and webhooks report manual.

Allowed:
string

Free-text notes describing the block. Stored and visible in the backoffice.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json