Skip to main content
DELETE
/
v2
/
identity
/
identities
/
{identity_id}
/
controls
[
  {
    "control": "FROZEN",
    "set_by": "client",
    "reason_code": "CUSTOMER_REQUESTED",
    "reason": "Customer requested temporary account freeze"
  },
  {
    "control": "FROZEN",
    "set_by": "paxos",
    "reason_code": "SANCTIONS_PEP_OR_NN",
    "reason": "Account flagged for sanctions screening"
  },
  {
    "control": "CLOSED",
    "set_by": "client",
    "reason_code": "DORMANT",
    "reason": "No activity for 12 months"
  }
]

Path Parameters

​
identity_id
string
required

The Identity ID

Body

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

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