Pular para o conteúdo principal
List Customers
curl --request GET \
  --url https://api.spherepay.co/v2/customer \
  --header 'Authorization: Bearer <token>'
{
  "customers": [
    {
      "id": "customer_f31121c389624d3697cbf3ea8830b7a4",
      "type": "individual",
      "email": "jane.smith@example.com",
      "phone": "+14155550123",
      "firstName": "Jane",
      "lastName": "Smith",
      "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": []
          }
        }
      ],
      "meta": {},
      "createdAt": "2026-03-09T20:46:31.305Z",
      "updatedAt": "2026-03-09T20:46:31.305Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrevious": false
  }
}
Use este endpoint para recuperar todos os clientes associados à sua conta SpherePay. Os resultados são retornados em páginas, e você pode filtrar por status ou tipo de cliente para restringir a lista. Cada item na resposta inclui o perfil de verificação do cliente, para que você possa identificar rapidamente quais clientes estão prontos para transferências.

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de consulta

object
obrigatório

Resposta

customers
(Individual · object | Business · object)[]
obrigatório

Array of customer objects

Response containing information about an individual customer.

pagination
object
obrigatório
Última modificação em 18 de junho de 2026