Skip to main content
GET
/
identity
/
identities
{
  "items": [
    {
      "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
      "status": "DISABLED",
      "status_details": {
        "active_controls": [
          {
            "type": "DISABLED",
            "controlled_by": "CLIENT",
            "reason_code": "END_USER_REQUESTED",
            "reason": "some client-set reason"
          },
          {
            "type": "DISABLED",
            "controlled_by": "PAXOS",
            "reason_code": "OTHER",
            "reason": "some admin-set reason"
          },
          {
            "type": "FROZEN",
            "controlled_by": "PAXOS",
            "reason_code": "SANCTIONS",
            "reason": "some admin-set reason"
          },
          {
            "type": "DORMANT",
            "controlled_by": "CLIENT",
            "reason_code": "DORMANT",
            "reason": "some reason"
          }
        ],
        "pending_requirements": [
          {
            "requirement": "PENDING_ID_VERIFICATION",
            "message": "ID Verification"
          },
          {
            "requirement": "PENDING_SANCTIONS_SCREENING",
            "message": "Sanctions Screening"
          },
          {
            "requirement": "PENDING_ADDITIONAL_SCREENING",
            "message": "PEP/Adverse Media Screening"
          },
          {
            "requirement": "PENDING_MEMBERS",
            "message": "Pending members",
            "metadata": {
              "f190b163-208f-4d73-8deb-000000000001": "PENDING"
            }
          }
        ],
        "failed_requirements": [
          {
            "requirement": "FAILED_ENHANCED_DUE_DILIGENCE",
            "message": "Enhanced Due Diligence"
          },
          {
            "requirement": "FAILED_RISK_AWARENESS_ASSESSMENT",
            "message": "Risk Awareness Assessment"
          },
          {
            "requirement": "DISABLED_MEMBERS",
            "message": "Disabled members",
            "metadata": {
              "f190b163-208f-4d73-8deb-000000000002": "DISABLED"
            }
          },
          {
            "requirement": "RISK_RATING",
            "message": "Jurisdiction not supported by Paxos"
          }
        ]
      }
    }
  ],
  "next_page_cursor": "<string>"
}

Query Parameters

​
summary_status
enum<string>

Filter by identity status

Available options:
PENDING,
ERROR,
APPROVED,
DENIED,
DISABLED
​
active_controls
enum<string>[]

Filter by active identity controls

​
identity_type
enum<string>

Filter by identity type

Available options:
PERSON,
INSTITUTION
​
created_at.lt
string<date-time>

Return identities created before this timestamp

​
created_at.lte
string<date-time>

Return identities created before or at this timestamp

​
created_at.eq
string<date-time>

Return identities created at exactly this timestamp

​
created_at.gte
string<date-time>

Return identities created at or after this timestamp

​
created_at.gt
string<date-time>

Return identities created after this timestamp

​
updated_at.lt
string<date-time>

Return identities updated before this timestamp

​
updated_at.lte
string<date-time>

Return identities updated before or at this timestamp

​
updated_at.eq
string<date-time>

Return identities updated at exactly this timestamp

​
updated_at.gte
string<date-time>

Return identities updated at or after this timestamp

​
updated_at.gt
string<date-time>

Return identities updated after this timestamp

​
limit
integer
default:50

Number of results to return

Required range: 1 <= x <= 100
​
order
enum<string>
default:DESC

Order of results

Available options:
DESC,
ASC
​
order_by
enum<string>
default:CREATED_AT

Field to order results by

Available options:
CREATED_AT
​
page_cursor
string

Cursor for pagination

Response

A successful response.

​
items
object[]
required

List of identities

​
next_page_cursor
string

Cursor for the next page of results