Skip to main content
GET
/
identity
/
identities
{
  "next_page_cursor": "<string>",
  "items": [
    {
      "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
      "status": "DISABLED",
      "status_details": {
        "active_controls": [
          {
            "id": "59b8e3c5-2b6e-4fa6-afcf-8c685598241d",
            "type": "CLOSED",
            "controlled_by": "CLIENT",
            "reason_code": "END_USER_REQUESTED",
            "reason": "some client-set reason",
            "created_at": "2006-01-02T15:04:05Z"
          },
          {
            "id": "5f1eb60c-b292-482c-96fe-9e3e265abcd4",
            "type": "CLOSED",
            "controlled_by": "PAXOS",
            "reason_code": "OTHER",
            "reason": "some admin-set reason",
            "created_at": "2006-01-02T15:04:05Z"
          }
        ],
        "pending_requirements": [
          {
            "type": "ID_VERIFICATION",
            "message": "Pending ID Verification"
          },
          {
            "type": "SANCTIONS_SCREENING",
            "message": "Pending Sanctions Screening"
          },
          {
            "type": "ADDITIONAL_SCREENING",
            "message": "Pending PEP/Adverse Media Screening"
          },
          {
            "type": "MEMBERS",
            "message": "Pending members",
            "metadata": {
              "f190b163-208f-4d73-8deb-000000000001": "PENDING"
            }
          }
        ],
        "failed_requirements": [
          {
            "type": "ENHANCED_DUE_DILIGENCE",
            "message": "Failed Enhanced Due Diligence checks"
          },
          {
            "type": "RISK_AWARENESS_ASSESSMENT",
            "message": "Failed Risk Awareness Assessment"
          },
          {
            "type": "DISABLED_MEMBERS",
            "message": "Disabled members",
            "metadata": {
              "f190b163-208f-4d73-8deb-000000000002": "DISABLED"
            }
          },
          {
            "type": "RISK_RATING",
            "message": "Jurisdiction not supported by Paxos"
          }
        ]
      }
    }
  ]
}
OAuth Scope
identity:read_identity

Query Parameters

​
summary_status
enum<string>

Summary Status of the Identity.

Available options:
PENDING,
ERROR,
APPROVED,
DENIED,
DISABLED
​
created_at.lt
string<date-time>

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.lte
string<date-time>

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.eq
string<date-time>

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.gte
string<date-time>

Include timestamps greater than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.gt
string<date-time>

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
updated_at.lt
string<date-time>

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
updated_at.lte
string<date-time>

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
updated_at.eq
string<date-time>

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

​
updated_at.gte
string<date-time>

Include timestamps greater than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
updated_at.gt
string<date-time>

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
limit
integer

Number of results to return.

​
order
enum<string>

Return items in ascending (ASC) or descending (DESC) order. Defaults to DESC.

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

The specific method by which the returned results will be ordered.

Available options:
CREATED_AT
​
page_cursor
string

Cursor token for fetching the next page.

​
identity_type
enum<string>

Optionally filter by Identity type

Available options:
PERSON,
INSTITUTION
​
active_control_type
enum<string>

Optionally filter by active identity control type

Available options:
CLOSED,
FROZEN,
DORMANT
​
active_control_reason_code
enum<string>

Optionally filter by active identity control reason code

Available options:
OTHER,
DORMANT,
END_USER_REQUESTED,
SANCTIONS

Response

200 - application/json

A successful response.

​
next_page_cursor
string

Cursor token required for fetching the next page.

​
items
object[]

The result list of identities.