List all customers

GET 
/v1/customers

Retrieves a paginated list of customers. This endpoint supports:

• Filtering for direct children only
• Including related entities (wallets and portfolios)
• Pagination and sorting

Request

Query Parameters

limit number

Possible values: >= 1 and <= 200

Default value: 20

The number of items to return

offset number

Default value: 0

The number of items to skip

include string[]

Possible values: [portfolios, wallets]

Fields to include in the response

sortBy string

Possible values: [firstName, lastName, email, id]

Field to sort by

Responses

200

Successfully retrieved the list of customers with pagination information.

application/json

Schema

Schema

traceId string
message string

data

object[]

Array [

id stringrequired

type stringrequired

email string

Email address

phoneNumber string

Phone number

phoneCountryCode string

Phone country code, e.g. "1" for USA

kyc

object

KYC profile data

sex string

Possible values: [male, female]

Sex from the person's documents

birthDate string

Birth date in YYYY-MM-DD format

firstName string

First name

middleName string

Middle name

lastName string

Last name

documentSsn string

Social Security Number

documentIdCard string

ID card number

documentLicense string

Driver license number

documentPassport string

Passport number

mainAddress

object

Registration address

street1 stringrequired

Street address line 1

street2 string

Street address line 2

cityCounty stringrequired

City or county

stateRegion string

State or region

zip stringrequired

ZIP or postal code

countryCode stringrequired

Possible values: [AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KP, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW]

ISO 3166-1 Alpha-2

nationality string

Possible values: [AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KP, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW]

Nationality, ISO 3166-1 Alpha-2

taxIdCountry string

Possible values: [AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KP, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW]

Country that issued the SSN / tax ID document (ISO 3166-1 Alpha-2)

occupation string

Possible values: [11, 13, 15, 17, 19, 21, 23, 25, 27, 29, 31, 33, 35, 37, 39, 41, 43, 45, 47, 49, 51, 53, 55, SELFEMP, OTHERXX, STUDENT, RETIRED, UNEMPLO]

Occupation code

ipAddress string

IP address associated with the customer

billingAddress

object

Billing address

street1 stringrequired

Street address line 1

street2 string

Street address line 2

cityCounty stringrequired

City or county

stateRegion string

State or region

zip stringrequired

ZIP or postal code

countryCode stringrequired

Possible values: [AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KP, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW]

ISO 3166-1 Alpha-2

deliveryAddress

object

Delivery address

street1 stringrequired

Street address line 1

street2 string

Street address line 2

cityCounty stringrequired

City or county

stateRegion string

State or region

zip stringrequired

ZIP or postal code

countryCode stringrequired

Possible values: [AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KP, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW]

ISO 3166-1 Alpha-2

portfolios

object[]

Array [

id stringrequired

The ID of the portfolio

default booleanrequired

Whether this portfolio is the default portfolio

wallets string[]required

The IDs of the wallets in the portfolio

]

onboardingId string

The ID of the most recent onboarding for this customer

bankingInfo

object

Banking information (virtual account number and VRN)

virtual_account_number string

Virtual account number

virtual_reference_number string

Virtual Reference Number (VRN) for ACH/FedWire

]

pagination

object

totalResults numberrequired

hasMoreResults booleanrequired

Example (from schema)

{
  "traceId": "string",
  "message": "string",
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "PRIVATE",
      "email": "john@example.com",
      "phoneNumber": "5551234567",
      "phoneCountryCode": "1",
      "kyc": {
        "sex": "male",
        "birthDate": "1990-01-01",
        "firstName": "John",
        "middleName": "Robert",
        "lastName": "Doe",
        "documentSsn": "string",
        "documentIdCard": "string",
        "documentLicense": "string",
        "documentPassport": "string",
        "mainAddress": {
          "street1": "123 Main St",
          "street2": "Apt 4B",
          "cityCounty": "New York",
          "stateRegion": "NY",
          "zip": "10001",
          "countryCode": "US"
        },
        "nationality": "AF",
        "taxIdCountry": "AF",
        "occupation": "11",
        "ipAddress": "192.168.0.1"
      },
      "billingAddress": {
        "street1": "123 Main St",
        "street2": "Apt 4B",
        "cityCounty": "New York",
        "stateRegion": "NY",
        "zip": "10001",
        "countryCode": "US"
      },
      "deliveryAddress": {
        "street1": "123 Main St",
        "street2": "Apt 4B",
        "cityCounty": "New York",
        "stateRegion": "NY",
        "zip": "10001",
        "countryCode": "US"
      },
      "portfolios": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "default": true,
          "wallets": [
            "string"
          ]
        }
      ],
      "onboardingId": "00000000-0000-0000-0000-000000000000",
      "bankingInfo": {
        "virtual_account_number": "256783259046169",
        "virtual_reference_number": "9876543210"
      }
    }
  ],
  "pagination": {
    "totalResults": 0,
    "hasMoreResults": true
  }
}

400

Invalid request payload. This can happen if required fields are missing or have invalid formats.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

403

The API key is invalid or the client does not have sufficient permissions.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

404

One of the specified resources was not found. Does not apply for empty result set.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

Loading...