Pular para o conteúdo principal
Get a customer by ID
curl --request GET \
  --url https://api.spherepay.co/v2/customer/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}
Use este endpoint para buscar os detalhes completos de um único cliente pelo seu ID único. A resposta inclui o status atual do perfil de verificação do cliente, que indica exatamente quais critérios de KYC/KYB permanecem pendentes antes que o cliente possa iniciar uma transferência. Você também pode inspecionar contas bancárias e carteiras vinculadas por meio deste registro.

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

id
string
obrigatório

Customer ID

Exemplo:

"customer_f31121c389624d3697cbf3ea8830b7a4"

Resposta

Response containing information about an individual customer.

id
string
obrigatório

Customer ID

Exemplo:

"customer_f31121c389624d3697cbf3ea8830b7a4"

verificationProfiles
object[]
obrigatório

Array of verification profiles. For individual customers, this will include kyc_profile_a. For business customers, this will include kyb_profile_a. See KYC Flow for individuals or KYB Flow for businesses. See Verification Profile for individual status definitions and criteria breakdown or Verification Profile for business status definitions and criteria breakdown.

Exemplo:
[
{
"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": []
}
}
]
createdAt
string
obrigatório

ISO 8601 formatted customer creation timestamp

Exemplo:

"2026-03-09T20:46:31.305Z"

updatedAt
string
obrigatório

ISO 8601 formatted customer update timestamp

Exemplo:

"2026-03-09T20:46:31.305Z"

type
enum<string>
obrigatório

Customer type

Opções disponíveis:
individual
Exemplo:

"individual"

email
string

Customer email address

Exemplo:

"jane.smith@example.com"

phone
string

Customer phone number

Exemplo:

"+14155550123"

meta
object
firstName
string

Customer first name (individual customers only)

Exemplo:

"Jane"

lastName
string

Customer last name (individual customers only)

Exemplo:

"Smith"

Última modificação em 18 de junho de 2026