Skip to main content
POST
/
v2
/
identity
/
identities
/
{identity_id}
/
controls
{
  "control": "FROZEN",
  "set_by": "client",
  "reason_code": "CUSTOMER_REQUESTED",
  "reason": "Customer requested temporary account freeze"
}

Path Parameters

​
identity_id
string
required

The Identity ID

Body

application/json
​
control
enum<string>
required
Available options:
FROZEN,
CLOSED
​
reason_code
enum<string>
required

Standardized reason codes for identity control actions

Available options:
DORMANT,
CUSTOMER_REQUESTED,
SANCTIONS_PEP_OR_NN
​
reason
string

Additional free text details about the reason for setting the control

Response

A successful response.

​
control
enum<string>
Available options:
FROZEN,
CLOSED
​
set_by
enum<string>

Who set this control - either 'paxos' or 'client'

Available options:
paxos,
client
​
reason_code
enum<string>

Standardized reason codes for identity control actions

Available options:
DORMANT,
CUSTOMER_REQUESTED,
SANCTIONS_PEP_OR_NN
​
reason
string

Additional details about why this identity control was set