Effortless customer verification now available   View changelog
Sphere Paysphere
Customer

List Customers

List all customers (paginated)

GET
/v2/customer
AuthorizationBearer <token>

In: header

Query Parameters

object

Response Body

curl -X GET "https://api.spherepay.co/v2/customer?page=1&limit=10"
{
  "customers": [
    {
      "id": "customer_66c4168d418a410eae282b83883bdc39",
      "email": "user@example.com",
      "phone": "+1234567890",
      "firstName": "John",
      "lastName": "Doe",
      "businessLegalName": "John Doe Pte Ltd.",
      "businessTradeName": "John Doe Brand",
      "verificationProfiles": [
        {
          "name": "kyc_profile_a",
          "status": "incomplete",
          "criteria": {
            "complete": [
              "email_address",
              "phone_number",
              "residential_address",
              "tax_identification_number"
            ],
            "pending": [],
            "required": [
              "terms_of_service",
              "email_verification",
              "phone_verification",
              "identity_document",
              "liveness_check",
              "identity_verification",
              "kyc_a_approval"
            ],
            "errors": []
          }
        }
      ],
      "meta": {
        "property1": null,
        "property2": null
      },
      "createdAt": "2025-11-21T07:10:54.598Z",
      "updatedAt": "2025-11-21T07:10:54.598Z",
      "type": "individual"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrevious": false
  }
}

{
  "status": 400,
  "detail": "Invalid request parameters",
  "code": "address/invalid",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}

{
  "status": 404,
  "detail": "Resource not found",
  "code": "resource/not-found",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}

{
  "status": 422,
  "detail": "Validation failed",
  "code": "validation/failed",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
  "errors": [
    {
      "detail": "Invalid email format",
      "pointer": "/email"
    },
    {
      "detail": "Name is required",
      "pointer": "/name"
    }
  ]
}