Sign in
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",
      "endUserTermsConsent": {
        "ipAddress": "198.51.100.24",
        "termsVersion": "V1",
        "acceptanceMethod": "CHECKBOX"
      },
      "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"
      },
      "idType": "SSN",
      "identifier": "123-45-6789",
      "countryOfIssuance": "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"
    }
  ]
}

Changes

Changed in 6 of the 24 revisions of this API.22011

  • 27ff0fdca01c33See the full diff
    • ●

      removed the optional property data/items/oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/allOf[subschema #1]/taxIdCountryOfIssuance from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/allOf[subschema #1]/taxIdType from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/allOf[subschema #1]/taxIdentifier from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property data/items/oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/allOf[subschema #1]/countryOfIssuance to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/allOf[subschema #1]/idType to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional write-only property data/items/oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/allOf[subschema #1]/identifier to the response with the 200 status

      response-optional-write-only-property-added

  • aaa1fb8782c81See the full diff
    • ●

      added the new EXTERNAL_ACCOUNT_VERIFICATION_REQUIRED enum value to the code response property for the response status 400

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • df12ec487f0e1See the full diff
    • ●

      added the new TRANSACTION_SIZE_LIMIT_EXCEEDED enum value to the code response property for the response status 400

      response-property-enum-value-added

  • b06902b6595a1See the full diff
    • ●

      added the new CARDHOLDER_KYC_NOT_APPROVED enum value to the code response property for the response status 400

      response-property-enum-value-added

  • 526036c1260916See the full diff
    • ●

      added the new END_USER_TERMS_VERSION_NOT_FOUND enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ○

      added the optional property data/items/oneOf[subschema #1: Individual Customer]/allOf[Customer]/endUserTermsConsent to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/oneOf[subschema #2: Business Customer]/allOf[BusinessCustomerFields]/businessInfo/primaryContactFirstName to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/oneOf[subschema #2: Business Customer]/allOf[BusinessCustomerFields]/businessInfo/primaryContactLastName to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/oneOf[subschema #2: Business Customer]/allOf[Customer]/endUserTermsConsent to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/oneOf[subschema #2: Business Customer]/allOf[subschema #3]/businessInfo/primaryContactFirstName to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/oneOf[subschema #2: Business Customer]/allOf[subschema #3]/businessInfo/primaryContactLastName to the response with the 200 status

      response-optional-property-added

  • b21ed434ee6e2132See the full diff
    • ▲

      the data/items/oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property data/items/oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/customerType from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property data/items/oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/address from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/birthDate from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/fullName from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/kycStatus from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/nationality from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new CHARITY enum value to the data/items/oneOf[subschema #2: Business Customer]/allOf[BusinessCustomerFields]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new CHARITY enum value to the data/items/oneOf[subschema #2: Business Customer]/allOf[subschema #3]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new PRIVATE_FOUNDATION enum value to the data/items/oneOf[subschema #2: Business Customer]/allOf[BusinessCustomerFields]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new PRIVATE_FOUNDATION enum value to the data/items/oneOf[subschema #2: Business Customer]/allOf[subschema #3]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new PUBLICLY_LISTED_COMPANY enum value to the data/items/oneOf[subschema #2: Business Customer]/allOf[BusinessCustomerFields]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new PUBLICLY_LISTED_COMPANY enum value to the data/items/oneOf[subschema #2: Business Customer]/allOf[subschema #3]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new TRUST enum value to the data/items/oneOf[subschema #2: Business Customer]/allOf[BusinessCustomerFields]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new TRUST enum value to the data/items/oneOf[subschema #2: Business Customer]/allOf[subschema #3]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property details/errors to the response with the 400 status

      response-optional-property-added

    • ○

      added CustomerEdd subschema #1 to the data/items/oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/ response property allOf list for the response status 200

      response-property-all-of-added