Skip to main content
GET
/
v2
/
identity
/
identities
{
  "identities": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "ref_id": "<string>",
      "identity_type": "PERSON",
      "status": "PENDING",
      "status_details": {
        "pending_verifications": {
          "message": "<string>",
          "metadata": {
            "statuses": [
              {
                "type": "IDV",
                "status": "PENDING"
              }
            ]
          }
        },
        "pending_edd": {
          "message": "<string>"
        },
        "pending_member_approvals": {
          "message": "<string>",
          "metadata": {
            "pending_members": [
              "<string>"
            ]
          }
        },
        "failed_verifications": {
          "message": "<string>",
          "metadata": {
            "statuses": [
              {
                "type": "IDV",
                "status": "FAILED"
              }
            ]
          }
        },
        "prohibited_risk_rating": {
          "message": "<string>"
        },
        "failed_controls": {
          "message": "<string>",
          "metadata": {
            "dormant": true,
            "frozen": true,
            "closed": true,
            "denied": true,
            "admin_controls": {
              "dormant": true,
              "frozen": true,
              "closed": true,
              "denied": true
            }
          }
        },
        "failed_members": {
          "message": "<string>",
          "metadata": {
            "failed_members": [
              "<string>"
            ]
          }
        }
      },
      "person_details": {
        "first_name": "<string>",
        "last_name": "<string>",
        "middle_name": "<string>",
        "date_of_birth": "2023-12-25",
        "address": {
          "street_address": "<string>",
          "street_address_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        },
        "email_address": "<string>",
        "phone_number": "<string>",
        "country_of_citizenship": "<string>",
        "country_of_birth": "<string>",
        "ssn": "<string>",
        "occupation": "<string>",
        "identity_verification_status": "PENDING",
        "aml_screening_status": "PENDING"
      },
      "institution_details": {
        "legal_name": "<string>",
        "doing_business_as_name": "<string>",
        "address": {
          "street_address": "<string>",
          "street_address_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        },
        "incorporation_date": "2023-12-25",
        "country_of_formation": "<string>",
        "industry_type": "<string>",
        "legal_entity_type": "<string>",
        "website": "<string>",
        "business_description": "<string>",
        "members": [
          {
            "first_name": "<string>",
            "last_name": "<string>",
            "title": "<string>",
            "ownership_percentage": 123,
            "date_of_birth": "2023-12-25",
            "address": {
              "street_address": "<string>",
              "street_address_2": "<string>",
              "city": "<string>",
              "state": "<string>",
              "postal_code": "<string>",
              "country": "<string>"
            },
            "ssn": "<string>",
            "is_control_person": true
          }
        ],
        "identity_verification_status": "PENDING",
        "aml_screening_status": "PENDING"
      },
      "tax_details": [
        {
          "tax_id": "<string>",
          "tax_id_type": "SSN",
          "country": "<string>",
          "verification_status": "PENDING"
        }
      ],
      "customer_due_diligence": {
        "source_of_funds": "<string>",
        "purpose_of_account": "<string>",
        "expected_activity_level": "LOW",
        "verification_status": "PENDING"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "controls": {
        "available_actions": [
          "CRYPTO_WITHDRAWAL"
        ],
        "dormant": true,
        "frozen": true,
        "closed": true,
        "denied": true,
        "admin_controls": {
          "dormant": true,
          "frozen": true,
          "closed": true,
          "denied": true
        }
      }
    }
  ],
  "next_page_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
status
enum<string>[]

Optionally filter by status.

​
identity_type
enum<string>[]

Optionally filter by identity type.

​
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 gte. 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 gte. 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. Defaults to 100 if no limit is provided. Maximum 100.

​
order
enum<string>

Sort order for the results. Defaults to DESC by created_at time.

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

Field to sort by. Defaults to created_at.

Available options:
created_at,
updated_at
​
page_cursor
string

Optional cursor for getting the next page of results.

Response

A successful response.

​
identities
object[]
​
next_page_cursor
string