v5

OpenAPI 3.1.0Proprietary2026-08-011476181.4 MB

Customers

List customers

Retrieve a list of customers with optional filtering parameters. Returns all customers that match the specified filters. If no filters are provided, returns all customers (paginated).

get/customers

Query parameters

platformCustomerIdstring

Filter by platform-specific customer identifier

customerType'INDIVIDUAL' | 'BUSINESS'

Whether the customer is an individual or a business entity

Example:INDIVIDUAL

Filter by customer type

createdAfterstring date-time

Filter customers created after this timestamp (inclusive)

createdBeforestring date-time

Filter customers created before this timestamp (inclusive)

updatedAfterstring date-time

Filter customers updated after this timestamp (inclusive)

updatedBeforestring date-time

Filter customers updated before this timestamp (inclusive)

limitinteger

Maximum number of results to return (default 20, max 100)

cursorstring

Cursor for pagination (returned from previous request)

regionstring

Filter by customer region (ISO 3166-1 alpha-2 country code)

currencystring

Filter by currency code. Returns customers that have this currency in their enabled currencies list.

umaAddressstring

Filter by uma address

isIncludingDeletedboolean

Whether to include deleted customers in the results. Default is false.

Response

Successful operation

hasMoreboolean required

Indicates if more results are available beyond this page

nextCursorstring

Cursor to retrieve the next page of results (only present if hasMore is true)

totalCountinteger

Total number of customers matching the criteria (excluding pagination)

Example response

{
  "data": [
    {
      "id": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "platformCustomerId": "9f84e0c2a72c4fa",
      "customerType": "INDIVIDUAL",
      "region": "US",
      "currencies": [
        "USD",
        "USDC"
      ],
      "email": "john.doe@example.com",
      "phoneNumber": "+14155551234",
      "umaAddress": "$john.doe@uma.domain.com",
      "createdAt": "2025-07-21T17:32:28Z",
      "updatedAt": "2025-07-21T17:32:28Z",
      "contactVerification": {
        "email": "VERIFIED",
        "phone": "VERIFIED"
      },
      "kycStatus": "APPROVED",
      "fullName": "John Michael Doe",
      "birthDate": "1990-01-15",
      "nationality": "US",
      "address": {
        "line1": "123 Main Street",
        "line2": "Apt 4B",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94105",
        "country": "US"
      },
      "taxIdType": "SSN",
      "taxIdentifier": "123-45-6789",
      "taxIdCountryOfIssuance": "US",
      "sourceOfFundsCategories": [
        "SALARY"
      ],
      "sourceOfFundsOtherDescription": "Contest winnings",
      "sourceOfWealthCategories": [
        "SALARY",
        "INVESTMENTS"
      ],
      "sourceOfWealthOtherDescription": "Royalty income from published works",
      "purposeOfAccount": "CONTRACTOR_PAYOUTS",
      "purposeOfAccountOtherDescription": "Household budgeting between spouses",
      "expectedMonthlyTransactionCount": "COUNT_100_TO_500",
      "expectedMonthlyTransactionVolume": "VOLUME_100K_TO_1M",
      "annualIncomeRange": "RANGE_100K_250K",
      "netWorthRange": "RANGE_500K_1M",
      "pepStatus": "NONE"
    }
  ]
}