Delete Identity Control

Delete a control setting for an identity.

DELETE /v2/identity/controls

Try it

200

[
  {
    "id": "59b8e3c5-2b6e-4fa6-afcf-8c685598241d",
    "type": "CLOSED",
    "set_by": "CLIENT",
    "is_overridable": true,
    "reason_code": "END_USER_REQUESTED",
    "reason": "User requested account closure",
    "created_at": "2006-01-02T15:04:05Z"
  },
  {
    "id": "5f1eb60c-b292-482c-96fe-9e3e265abcd4",
    "type": "CLOSED",
    "set_by": "PAXOS",
    "is_overridable": false,
    "reason_code": "COMPLIANCE",
    "reason": "Account flagged for compliance review",
    "created_at": "2006-01-02T15:04:05Z"
  },
  {
    "id": "ae54b3b4-cce6-4707-b34b-c9c4f0537798",
    "type": "DORMANT",
    "set_by": "CLIENT",
    "is_overridable": true,
    "reason_code": "INACTIVITY",
    "reason": "No activity for 180 days",
    "created_at": "2006-01-02T15:04:05Z",
    "deleted_at": "2006-01-02T15:04:05Z"
  }
]

OAuth Scope

identity:write_identity_control

Authorizations

Authorization · string · header · required

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

Body

application/json

identity_id · string · required

The Identity ID

id · string · required

The ID of the identity control to delete

reason · string

Freetext reason for clearing the control

Response

200

application/json

A successful response.

id · string

Unique identifier for this control

type · enum<string>

The type of control applied to an identity.

• CLOSED: Identity is closed and cannot perform any actions
• FROZEN: Identity is frozen due to compliance reasons
• DORMANT: Identity is dormant due to inactivity

Available options: CLOSED, FROZEN, DORMANT

set_by · enum<string>

Indicates who set the control.

• PAXOS: Control was set by Paxos (e.g., for compliance or risk reasons)
• CLIENT: Control was set by the client application

Available options: PAXOS, CLIENT

is_overridable · boolean

Whether this control can be deleted by the client application

reason_code · enum<string>

Reason code for why a control was applied.

• OTHER: Miscellaneous reason
• END_USER_REQUEST: Control applied at the end user's request
• COMPLIANCE: Control applied for compliance or regulatory reasons
• INACTIVITY: Identity is has been inactive for an extended period of time

Available options: OTHER, END_USER_REQUEST, COMPLIANCE, INACTIVITY

reason · string

Freetext reason why this identity control was set

created_at · string<date-time>

Time this identity control was created

deleted_at · string<date-time>

Time this identity control was deleted

Example:

[
  {
    "id": "59b8e3c5-2b6e-4fa6-afcf-8c685598241d",
    "type": "CLOSED",
    "set_by": "CLIENT",
    "is_overridable": true,
    "reason_code": "END_USER_REQUESTED",
    "reason": "User requested account closure",
    "created_at": "2006-01-02T15:04:05Z"
  },
  {
    "id": "5f1eb60c-b292-482c-96fe-9e3e265abcd4",
    "type": "CLOSED",
    "set_by": "PAXOS",
    "is_overridable": false,
    "reason_code": "COMPLIANCE",
    "reason": "Account flagged for compliance review",
    "created_at": "2006-01-02T15:04:05Z"
  },
  {
    "id": "ae54b3b4-cce6-4707-b34b-c9c4f0537798",
    "type": "DORMANT",
    "set_by": "CLIENT",
    "is_overridable": true,
    "reason_code": "INACTIVITY",
    "reason": "No activity for 180 days",
    "created_at": "2006-01-02T15:04:05Z",
    "deleted_at": "2006-01-02T15:04:05Z"
  }
]