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

cURL

cURL

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/customers \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "data": [
    {
      "platformCustomerId": "9f84e0c2a72c4fa",
      "customerType": "INDIVIDUAL",
      "umaAddress": "$[e-mail]",
      "id": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "region": "US",
      "currencies": [
        "USD",
        "USDC"
      ],
      "email": "[e-mail]",
      "phoneNumber": "[phone]",
      "createdAt": "2025-07-21T17:32:28Z",
      "updatedAt": "2025-07-21T17:32:28Z",
      "isDeleted": false,
      "contactVerification": {
        "email": "VERIFIED",
        "phone": "VERIFIED"
      },
      "kycStatus": "APPROVED",
      "fullName": "John Michael Doe",
      "birthDate": "1990-01-15",
      "nationality": "US",
      "address": {
        "line1": "123 Main Street",
        "postalCode": "94105",
        "country": "US",
        "line2": "Apt 4B",
        "city": "San Francisco",
        "state": "CA"
      },
      "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"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

API token authentication using format <api token id>:<api client secret>

Query Parameters

platformCustomerId · string

Filter by platform-specific customer identifier

customerType · enum<string>

Filter by customer type Whether the customer is an individual or a business entity

Available options: INDIVIDUAL, BUSINESS

Example:

"INDIVIDUAL"

createdAfter · string<date-time>

Filter customers created after this timestamp (inclusive)

createdBefore · string<date-time>

Filter customers created before this timestamp (inclusive)

updatedAfter · string<date-time>

Filter customers updated after this timestamp (inclusive)

updatedBefore · string<date-time>

Filter customers updated before this timestamp (inclusive)

limit · integer · default: 20

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

Required range: 1 <= x <= 100

cursor · string

Cursor for pagination (returned from previous request)

region · string

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

currency · string

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

umaAddress · string

Filter by uma address

isIncludingDeleted · boolean

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

Response

200

application/json

Successful operation

data · (Individual Customer · object | Business Customer · object)[] · required

List of customers matching the filter criteria

Enhanced-due-diligence (EDD) fields available as optional patchable attributes on an individual customer. Referenced via allOf from IndividualCustomerFields, so these appear as top-level optional fields on the customer resource itself; there is no separate EDD resource. The specific set required for a given customer is driven by the KYC provider's per-jurisdiction / per-flow / per-volume-tier rules (surfaced through MISSING_FIELD errors on POST /verifications).

Individual Customer

Business Customer

Show child attributes

hasMore · boolean · required

Indicates if more results are available beyond this page

nextCursor · string

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

totalCount · integer

Total number of customers matching the criteria (excluding pagination)