identity_summary_status_change

{
  "id": "d840cf31-352f-4190-a476-7522bf3eafda",
  "identity_id": "4fd025ab-f29f-47e6-a02e-df90a61c7ec9",
  "old_summary_status": "APPROVED",
  "new_summary_status": "DISABLED",
  "status_details": {
    "active_controls": [
      {
        "id": "ctrl-001",
        "type": "SELL_ONLY",
        "set_by": "SET_BY_PAXOS",
        "is_overridable": false,
        "reason_code": "COMPLIANCE_KYC",
        "reason": "Prohibited risk rating",
        "created_at": "2026-04-10T08:00:00Z"
      }
    ],
    "requirements": [
      {
        "type": "KYC_REFRESH",
        "status": "FAILED",
        "awaiting_action_from": "CLIENT",
        "errors": [
          {
            "code": "kyc_refresh_overdue",
            "description": "KYC refresh has expired."
          }
        ]
      },
      {
        "type": "SCREENING_CHECK",
        "status": "PENDING",
        "awaiting_action_from": "PAXOS",
        "errors": [
          {
            "code": "screening_in_progress",
            "description": "Screening check is in progress."
          }
        ]
      }
    ]
  }
}

This object is returned by the Get Event API when the event type is identity.approved, identity.denied, or identity.disabled.

Object Fields

string

required

Unique identifier for this event object

string

required

Identifier for the affected identity

string

required

The previous summary status of the identityAvailable options: PENDING, ERROR, APPROVED, DENIED, DISABLED

string

required

The new summary status of the identityAvailable options: PENDING, ERROR, APPROVED, DENIED, DISABLED

object

Detailed breakdown of the identity’s status at the time of the event, including active controls and outstanding requirements. See Using Status Details for full field descriptions.

Show status_details

array

Identity controls currently applied to the identity.

array

Outstanding requirements for the identity. Each entry describes a specific pending or failed requirement.

Show requirements

string

The requirement type.

string

The status of the requirement.Available options: PENDING, FAILED

string

Indicates who must act to resolve the requirement. Not present on MEMBERS type.Available options: PAXOS, CLIENT

array

Specific error details for developer use only. Do not expose these values directly to end users.

Show errors

string

Machine-readable error code.

string

Human-readable description of the error.

{
  "id": "d840cf31-352f-4190-a476-7522bf3eafda",
  "identity_id": "4fd025ab-f29f-47e6-a02e-df90a61c7ec9",
  "old_summary_status": "APPROVED",
  "new_summary_status": "DISABLED",
  "status_details": {
    "active_controls": [
      {
        "id": "ctrl-001",
        "type": "SELL_ONLY",
        "set_by": "SET_BY_PAXOS",
        "is_overridable": false,
        "reason_code": "COMPLIANCE_KYC",
        "reason": "Prohibited risk rating",
        "created_at": "2026-04-10T08:00:00Z"
      }
    ],
    "requirements": [
      {
        "type": "KYC_REFRESH",
        "status": "FAILED",
        "awaiting_action_from": "CLIENT",
        "errors": [
          {
            "code": "kyc_refresh_overdue",
            "description": "KYC refresh has expired."
          }
        ]
      },
      {
        "type": "SCREENING_CHECK",
        "status": "PENDING",
        "awaiting_action_from": "PAXOS",
        "errors": [
          {
            "code": "screening_in_progress",
            "description": "Screening check is in progress."
          }
        ]
      }
    ]
  }
}

identity_documents_required identity_kyc_refresh

⌘I

API Documentation

Deposits and Withdrawals

Address Verification

Identity

Profiles

Sandbox

Orchestrations / Conversions

Taxes

Trading

Rewards

Rewards Engine

Events

API Credentials

Websockets

Webhooks

Problems

Object Fields

​Object Fields

Object Fields