Customers

List customers

Changed on

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

Request

  • Base URL: https://api.lightspark.com/grid/2025-10-13
  • URL: https://api.lightspark.com/grid/2025-10-13/customers
  • Auth: HTTP basic

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"
      },
      "agreementConsents": [
        {
          "type": "LIGHTSPARK_END_USER_TERMS",
          "ipAddress": "198.51.100.24",
          "termsVersion": "2025-10-13",
          "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

  • d7ee05a962b2Revision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      the response optional property /////// became read-only for the status

    • info

      the response optional property /////// became read-only for the status

    • info

      added to the /////// response property allOf list for the response status

    • info

      added to the /////// response property allOf list for the response status

    • info

      removed from the /////// response property allOf list for the response status

    • info

      removed from the /////// response property allOf list for the response status

    • info

      response property data/items/oneOf[subschema #1: Individual Customer]/allOf[Customer]/endUserTermsConsent deprecated

    • info

      response property data/items/oneOf[subschema #2: Business Customer]/allOf[Customer]/endUserTermsConsent deprecated

  • 3966e5d38aadRevision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      added the new INSUFFICIENT_FUNDS enum value to the response property for the response status

    • warning

      added the new QUOTE_EXPIRED enum value to the response property for the response status

    • warning

      added the new QUOTE_RATE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new STABLECOIN_AMOUNT_NOT_REPRESENTABLE enum value to the response property for the response status

    • warning

      added the new STABLECOIN_BURN_SOURCE_NOT_SUPPORTED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_EXTERNAL_ACCOUNT_LINK_FAILED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_EXTERNAL_ACCOUNT_LINK_METHOD_REQUIRED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_EXTERNAL_ACCOUNT_NOT_LINKED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_EXTERNAL_ACCOUNT_NOT_SUPPORTED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_EXTERNAL_ACCOUNT_PROVIDER_LINK_FAILED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_EXTERNAL_ACCOUNT_PROVIDER_LINK_REQUIRED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_GRID_OPERATIONS_NOT_ENABLED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_NOT_PROVISIONED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_OPERATION_NOT_SUPPORTED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_PROVIDER_ERROR enum value to the response property for the response status

    • warning

      added the new STABLECOIN_PROVIDER_SOURCE_NOT_LINKED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_VERIFICATION_FAILED enum value to the response property for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status