Skip to main content
PUT
/
v2
/
identity
/
identities
/
{id}
/
controls
{
  "available_actions": [
    "CRYPTO_WITHDRAWAL"
  ],
  "dormant": true,
  "frozen": true,
  "closed": true,
  "denied": true,
  "admin_controls": {
    "dormant": true,
    "frozen": true,
    "closed": true,
    "denied": true
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string
required

The Identity ID

Body

application/json
​
frozen
boolean

Set the frozen status of the identity (mutually exclusive with dormant, closed, denied)

​
dormant
boolean

Set the dormant status of the identity (mutually exclusive with frozen, closed, denied)

​
closed
boolean

Close the identity permanently (cannot be undone, mutually exclusive with frozen, dormant, denied)

​
denied
boolean

Deny the identity (cannot be undone without resubmission, mutually exclusive with frozen, dormant, closed)

​
available_actions
enum<string>[]

List of actions currently available for this identity

​
reason
string

Freetext reason for the control action

Response

A successful response.

​
available_actions
enum<string>[]

List of actions currently available for this identity

​
dormant
boolean

Whether the identity is marked as dormant

​
frozen
boolean

Whether the identity is frozen

​
closed
boolean

Whether the identity is permanently closed

​
denied
boolean

Whether the identity has been denied

​
admin_controls
object

Controls applied by Paxos administrators for regulatory or risk management purposes