Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Identity Controls

Create Identity Control

Create a new identity control on an identity.

post/v2/identity/controls

Request body

identity_idstring required

The Identity ID

type'SELL_ONLY' | 'CLOSED' | 'DORMANT' required

The type of control applied to an identity.

  • SELL_ONLY: Identity may only sell
  • CLOSED: Identity is closed and cannot perform any actions
  • DORMANT: Identity is dormant due to inactivity
reason_code'OTHER' | 'END_USER_REQUEST' | 'INACTIVITY' | 'COMPLIANCE_KYC' | 'COMPLIANCE_EDD' | 'COMPLIANCE_SCREENING' | 'COMPLIANCE_INVESTIGATION' | 'COMPLIANCE_INCOMPLETE' | 'RISK_FRAUD' | 'LEGAL_ORDER' | 'ADMINISTRATIVE' required
  • OTHER: Miscellaneous reason not captured by existing categories.
  • END_USER_REQUEST: Control applied at the end user's request.
  • INACTIVITY: Control applied due to prolonged inactivity in accordance with dormancy or lifecycle management policies.
  • COMPLIANCE_KYC: Control applied due to unmet KYC requirements, including missing, expired, failed, or unresponsiveness to refresh obligations.
  • COMPLIANCE_EDD: Control applied due to Enhanced Due Diligence (EDD) requirements, including failure to complete EDD reviews, provide requested information, or satisfy heightened risk assessment criteria.
  • COMPLIANCE_SCREENING: Control applied as a result of sanctions, politically exposed person (PEP), or adverse media screening hits.
  • COMPLIANCE_INVESTIGATION: Control applied while an identity is under active compliance, risk, or regulatory investigation, including reviews triggered by monitoring alerts or external inquiries.
  • COMPLIANCE_INCOMPLETE: Control applied because the onboarding process was not successfully completed, including failure to respond to requests for information or provide required documentation.
  • RISK_FRAUD: Control applied due to suspected or confirmed fraud, abuse, or security risk, including account compromise, transaction fraud, or policy violations.
  • LEGAL_ORDER: Control applied to comply with a legal, regulatory, or law-enforcement directive, including court orders, asset preservation requests, or regulatory instructions.
  • ADMINISTRATIVE: Control applied for operational or platform-initiated reasons not attributable to the end user or compliance failure, such as system remediation or account restructuring.
reasonstring

Freetext reason for setting the control

Response

A successful response.

idstring required
type'SELL_ONLY' | 'CLOSED' | 'FROZEN' | 'DORMANT' required
set_by'SET_BY_PAXOS' | 'SET_BY_CLIENT' required
is_overridableboolean
reason_code'OTHER' | 'END_USER_REQUEST' | 'INACTIVITY' | 'COMPLIANCE_KYC' | 'COMPLIANCE_EDD' | 'COMPLIANCE_SCREENING' | 'COMPLIANCE_INVESTIGATION' | 'COMPLIANCE_INCOMPLETE' | 'RISK_FRAUD' | 'LEGAL_ORDER' | 'ADMINISTRATIVE'
  • OTHER: Miscellaneous reason not captured by existing categories.
  • END_USER_REQUEST: Control applied at the end user's request.
  • INACTIVITY: Control applied due to prolonged inactivity in accordance with dormancy or lifecycle management policies.
  • COMPLIANCE_KYC: Control applied due to unmet KYC requirements, including missing, expired, failed, or unresponsiveness to refresh obligations.
  • COMPLIANCE_EDD: Control applied due to Enhanced Due Diligence (EDD) requirements, including failure to complete EDD reviews, provide requested information, or satisfy heightened risk assessment criteria.
  • COMPLIANCE_SCREENING: Control applied as a result of sanctions, politically exposed person (PEP), or adverse media screening hits.
  • COMPLIANCE_INVESTIGATION: Control applied while an identity is under active compliance, risk, or regulatory investigation, including reviews triggered by monitoring alerts or external inquiries.
  • COMPLIANCE_INCOMPLETE: Control applied because the onboarding process was not successfully completed, including failure to respond to requests for information or provide required documentation.
  • RISK_FRAUD: Control applied due to suspected or confirmed fraud, abuse, or security risk, including account compromise, transaction fraud, or policy violations.
  • LEGAL_ORDER: Control applied to comply with a legal, regulatory, or law-enforcement directive, including court orders, asset preservation requests, or regulatory instructions.
  • ADMINISTRATIVE: Control applied for operational or platform-initiated reasons not attributable to the end user or compliance failure, such as system remediation or account restructuring.
reasonstring
created_atstring date-time required
deleted_atstring date-time