Skip to main content
List Customers
curl --request GET \
  --url https://api.spherepay.co/v2/customer \
  --header 'Authorization: Bearer <token>'
{
  "customers": [
    {
      "id": "customer_f31121c389624d3697cbf3ea8830b7a4",
      "verificationProfiles": [
        {
          "name": "kyc_profile_a",
          "status": "incomplete",
          "criteria": {
            "complete": [
              "email_address",
              "phone_number",
              "residential_address",
              "tax_identification_number"
            ],
            "pending": [],
            "required": [
              "identity_document",
              "liveness_report_document"
            ],
            "errors": []
          }
        }
      ],
      "tosStatus": "incomplete",
      "createdAt": "2026-03-09T20:46:31.305Z",
      "updatedAt": "2026-03-09T20:46:31.305Z",
      "type": "individual",
      "email": "jane.smith@example.com",
      "phone": "+14155550123",
      "meta": {},
      "firstName": "Jane",
      "lastName": "Smith",
      "dateOfBirth": "1990-01-15",
      "personalInformation": {
        "taxIdentificationNumberType": "ssn",
        "taxIdentificationNumberCountry": "USA",
        "taxIdentificationNumberDescription": "<string>",
        "gender": "male",
        "countryOfBirth": "USA",
        "nationality": "USA",
        "middleName": "James",
        "occupationSocCode": "15-1132",
        "residencyCountry": "USA",
        "sourceOfFunds": "salary"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrevious": false
  }
}
Use this endpoint to retrieve all customers associated with your SpherePay account. Results are returned in pages, and you can filter by customer status or type to narrow the list. Each item in the response includes the customer’s verification profile, so you can quickly identify which customers are ready for transfers.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

object
required

Response

customers
(Individual · object | Business · object)[]
required

Array of customer objects

Response containing information about an individual customer.

pagination
object
required
Last modified on June 18, 2026