Skip to main content
GET
/
identity
/
identities
{
  "next_page_cursor": "<string>",
  "items": [
    {
      "id": "<string>",
      "status": "PENDING",
      "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"
          },
          {
            "id": "173fdece-0792-4833-a6bb-232b461a9fa4",
            "type": "FROZEN",
            "controlled_by": "PAXOS",
            "reason_code": "SANCTIONS",
            "reason": "some admin-set reason",
            "created_at": "2006-01-02T15:04:05Z"
          },
          {
            "id": "ae54b3b4-cce6-4707-b34b-c9c4f0537798",
            "type": "DORMANT",
            "controlled_by": "CLIENT",
            "reason_code": "DORMANT",
            "reason": "some reason",
            "created_at": "2006-01-02T15:04:05Z"
          }
        ],
        "pending_requirements": [
          {
            "type": "ID_VERIFICATION",
            "message": "<string>",
            "metadata": {}
          }
        ],
        "failed_requirements": [
          {
            "type": "ID_VERIFICATION",
            "message": "<string>",
            "metadata": {}
          }
        ]
      },
      "type": "PERSON",
      "ref_id": "<string>",
      "metadata": {},
      "user_disabled": true,
      "admin_disabled": true,
      "person_details": {
        "id_verification_status": "PENDING",
        "sanctions_verification_status": "PENDING",
        "first_name": "<string>",
        "last_name": "<string>",
        "date_of_birth": "<string>",
        "govt_id": "<string>",
        "address": {
          "country": "<string>",
          "address1": "<string>",
          "address2": "<string>",
          "city": "<string>",
          "province": "<string>",
          "zip_code": "<string>"
        },
        "phone_number": "<string>",
        "email": "<string>",
        "nationality": "<string>",
        "verifier_id": "<string>",
        "verifier_type": "JUMIO",
        "id_verification_url": "<string>",
        "passthrough_verifier_type": "JUMIO",
        "passthrough_verified_at": "2023-11-07T05:31:56Z",
        "govt_id_type": "SSN",
        "cip_id": "<string>",
        "cip_id_type": "SSN",
        "cip_id_country": "<string>",
        "additional_screening_status": "PENDING",
        "profession": "<string>",
        "middle_name": "<string>",
        "country_of_birth": "<string>",
        "passthrough_verification_id": "<string>",
        "passthrough_verification_status": "PENDING",
        "passthrough_verification_fields": [
          "FULL_LEGAL_NAME"
        ]
      },
      "institution_details": {
        "sanctions_verification_status": "PENDING",
        "name": "<string>",
        "business_address": {
          "country": "<string>",
          "address1": "<string>",
          "address2": "<string>",
          "city": "<string>",
          "province": "<string>",
          "zip_code": "<string>"
        },
        "phone_number": "<string>",
        "email": "<string>",
        "institution_type": "TRUST",
        "institution_sub_type": "INVESTMENT",
        "cip_id": "<string>",
        "cip_id_type": "EIN",
        "cip_id_country": "<string>",
        "govt_registration_date": "2023-11-07T05:31:56Z",
        "incorporation_address": {
          "country": "<string>",
          "address1": "<string>",
          "address2": "<string>",
          "city": "<string>",
          "province": "<string>",
          "zip_code": "<string>"
        },
        "regulation_status": "US_REGULATED",
        "trading_type": "PRIVATE",
        "listed_exchange": "<string>",
        "ticker_symbol": "<string>",
        "parent_institution_name": "<string>",
        "regulator_name": "<string>",
        "regulator_jurisdiction": "<string>",
        "regulator_register_number": "<string>",
        "document_verification_status": "PENDING",
        "additional_screening_status": "PENDING",
        "doing_business_as": "<string>",
        "business_description": "<string>"
      },
      "institution_members": [
        {
          "identity_id": "<string>",
          "roles": [
            "BENEFICIAL_OWNER"
          ],
          "ownership": "<string>",
          "position": "<string>",
          "name": "<string>",
          "status": "PENDING",
          "id": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "tax_details": [
        {
          "tax_payer_id": "<string>",
          "tax_payer_country": "<string>",
          "tin_verification_status": "TIN_VERIFICATION_PENDING"
        }
      ],
      "tax_details_not_required": true,
      "summary_tin_verification_status": "TIN_VERIFICATION_PENDING",
      "customer_due_diligence": {
        "aliases": [
          "<string>"
        ],
        "estimated_net_worth": "NET_WORTH_0_TO_100K",
        "estimated_yearly_income": "INCOME_0_TO_50K",
        "expected_transfer_value": "TRANSFER_VALUE_0_TO_25K",
        "source_of_wealth": "INHERITANCE",
        "source_of_funds": "SALARY_DISBURSEMENT",
        "purpose_of_account": "INVESTMENT_TRADING",
        "employment_status": "CONTRACTUAL",
        "employment_industry_sector": "INVESTMENT",
        "industry_sector": "INVESTMENT",
        "has_underlying_trust_structure": true,
        "has_nominee_shareholders": true,
        "created_at": "2023-11-07T05:31:56Z",
        "is_publicly_traded": true,
        "merchant_funding_source": "BUSINESS_LOANS_FINANCING",
        "customer_regions": [
          "US_CANADA"
        ]
      },
      "is_merchant": true,
      "last_kyc_refresh_date": "2023-11-07T05:31:56Z"
    }
  ]
}
OAuth Scope
identity:read_identity

Query Parameters

​
status
enum<string>

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
​
control_type
enum<string>

Optionally filter by identity control type

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

Optionally filter by 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.

⌘I