Pular para o conteúdo principal
List Customers
curl --request GET \
  --url https://api.spherepay.co/v2/customer \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.spherepay.co/v2/customer"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.spherepay.co/v2/customer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.spherepay.co/v2/customer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.spherepay.co/v2/customer"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.spherepay.co/v2/customer")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.spherepay.co/v2/customer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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
  }
}
{
"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"
}
]
}
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 22 de junho de 2026