v1

latestOpenAPI 3.0.02026-07-224537337.5 KB

List Customers

List customers with optional server-side search, filters, and sort.

get/v2/customer

Query parameters

pagestring required

Page number of the list (default: 1)

limitstring required

Number of items per page (default: 10)

searchstring

Substring search across customer first name, last name, legal name, trade name, and email fields

emailstring email

Filter by exact customer email (individual or business)

countrystring

Filter by customer address country (ISO 3166-1 Alpha-3, e.g., USA, GBR, CAN). See Country Codes.

sortstring required

Comma-separated sort fields. Prefix with "-" for descending, "+" (or no prefix) for ascending. Allowed fields: created, updated. Example: "created,-updated".

{
  "search": "jane",
  "email": "jane@example.com",
  "country": "USA",
  "sort": "-created"
}

Response

Example response

{
  "customers": [
    {
      "id": "customer_f31121c389624d3697cbf3ea8830b7a4",
      "email": "jane.smith@example.com",
      "phone": "+14155550123",
      "verificationProfiles": [
        {
          "name": "kyc_profile_a",
          "status": "incomplete",
          "criteria": {
            "complete": [
              "email_address",
              "phone_number",
              "residential_address",
              "tax_identification_number"
            ],
            "pending": [],
            "required": [
              "identity_document",
              "liveness_report_document"
            ],
            "errors": []
          }
        }
      ],
      "tosStatus": "incomplete",
      "createdAt": "2026-03-09T20:46:31.305Z",
      "updatedAt": "2026-03-09T20:46:31.305Z",
      "type": "individual",
      "firstName": "Jane",
      "lastName": "Smith",
      "dateOfBirth": "1990-01-15",
      "personalInformation": {
        "taxIdentificationNumberType": "ssn",
        "taxIdentificationNumberCountry": "USA",
        "accountPurpose": "receive_salary",
        "gender": "male",
        "countryOfBirth": "USA",
        "nationality": "USA",
        "middleName": "James",
        "occupationSocCode": "15-1132",
        "residencyCountry": "USA",
        "sourceOfFunds": "salary"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1
  }
}