Skip to main content

Summary Status

An Identity has five (5) statuses:
  • PENDING: Initial state. The Identity is waiting for an Onboarding Decision and is under review.
  • APPROVED: The Identity passed internal review. It can be used with integrations, for example, creating orders.
  • DENIED: The Identity failed internal review. It cannot be used with integrations.
  • DISABLED: The Identity was APPROVED but has been off-boarded. It can only perform sell operations.
  • ERROR: The Identity has been frozen for compliance reasons. It cannot be used with integrations.
This status drives what actions the identity can perform across the platform according to the grid below:
StatusHold AssetsCreate Buy OrdersCreate Sell OrdersExecute Open OrdersCreate Crypto Deposit AddressCreate Crypto WithdrawalReceive Crypto Deposits
PENDING
DENIED
APPROVED
DISABLED❌*
ERROR❌*
*Crypto deposits received to identities in disabled or error status will be held for review.

Sub Statuses

The following sub-statuses are returned in identity responses and can be used to help explain why an Identity is in a given summary status.

Sanctions Verification Status (Persons & Institutions)

  • Field: sanctions_verification_status
    • PENDING: Sanctions check in progress.
    • DENIED: Sanctions hit found, cannot proceed.
    • APPROVED: No sanctions hit found, cleared to proceed.
    • ERROR: Possible sanctions hit, held for manual review.

Additional Screening Status (Persons & Institutions)

  • Field: additional_screening_status
    • PENDING: Additional screening checks are in progress.
    • DENIED: Failed additional screening checks.
    • APPROVED: Passed all additional screening checks.
    • ERROR: Possible screening hit, held for manual review.
Additional screening includes checking for negative news or politically exposed persons, but explicitly excludes any sanctions checks (covered by the above sanctions_verification_status).

ID Verification Status (Persons Only)

  • Field: id_verification_status
    • PENDING: Verification is in progress. Checking the identity of the person.
    • DENIED: Verification failed. Unable to verify the identity of the person.
    • APPROVED: Verification successful. The identity of the person is confirmed.
When using passthrough IDV, the id_verification_status will reflect the passthrough_verification_status that was set. Note that passthrough_verification_status can only ever be set to a terminal IDV status of APPROVED or DENIED.

Onboarding Decision

The onboarding decision is made based on the identities risk rating and the set of verifications (as exposed in sub-statuses above). Once there is sufficient information to make a decision, the Identity will be APPROVED and able to trade or DENIED and rejected services. In the happy path where an Identity is LOW

Requirements

The status_details.requirements array provides structured detail on what is blocking or pending for an identity. Use this to understand why an identity is PENDING, DENIED, or DISABLED. Each entry in requirements has the following fields:
FieldDescription
typeThe requirement type. See types below.
statusPENDING — not yet fulfilled; may be under review or require client action. FAILED — requirement was not met; check awaiting_action_from to determine if action is needed.
awaiting_action_fromWho must act to resolve the requirement: PAXOS or CLIENT. Not present on MEMBERS type.
errorsSpecific error details for developer use only — do not expose code or description values directly to end users. code is a fixed enum of values; additional codes may be added in the future.

Requirement types

TypeApplies toDescription
ID_VERIFICATIONPersonGovernment ID verification.
DOCUMENT_VERIFICATIONInstitutionBusiness document review.
SCREENING_CHECKBothBackground screening check.
COMPLIANCE_CHECKBothInternal compliance review.
ENHANCED_DUE_DILIGENCEInstitutionEnhanced due diligence review.
KYC_REFRESHPersonPeriodic re-verification of identity information.
TAX_DETAILS_VERIFICATIONBothTax identification number verification.
MEMBERSInstitution onlyOne or more institution members have outstanding requirements. Check institution_members in the response for details on which members are failing or pending.