Pular para o conteúdo principal
Advance a sandbox customer
Este endpoint funciona apenas em https://api.sandbox.spherepay.co. Ele informa um resultado de verificação simulado para um cliente, porque o sandbox nunca chama os provedores de verificação. approved aprova todos os perfis de verificação que o cliente tem (A, e C e D quando se aplicam), para que o cliente possa usar todas as rotas que esses perfis liberam; rejected rejeita todos eles. Passe profile para avançar um único perfil: A (kyc_profile_a, kyb_profile_a), ou aprovar C ou D (kyc_profile_c, kyc_profile_d, kyb_profile_c, kyb_profile_d) enquanto os demais ficam como estão. Clientes que fizeram onboarding pelo link de KYC hospedado são avançados da mesma forma. Avançar para o resultado atual não altera nada, e um cliente rejeitado não pode ser aprovado (422).

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

Corpo

application/json
outcome
enum<string>
obrigatório

The verification outcome the provider reports for the customer.

Opções disponíveis:
approved,
rejected
Exemplo:

"approved"

profile
enum<string>

Advance only this profile: A (kyc_profile_a, kyb_profile_a), or approve C or D (kyc_profile_c, kyc_profile_d, kyb_profile_c, kyb_profile_d) while the others stay as they are. Use the kyc_ names for individuals and the kyb_ names for businesses; a business C or D also covers its representatives. Omit it to advance every profile the customer has.

Opções disponíveis:
kyc_profile_a,
kyb_profile_a,
kyc_profile_c,
kyb_profile_c,
kyc_profile_d,
kyb_profile_d
Exemplo:

"kyc_profile_a"

Resposta

Response containing information about an individual customer.

createdAt
string
obrigatório

ISO 8601 formatted customer creation timestamp

Exemplo:

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

enabledVerificationProfiles
enum<string>[] | null
obrigatório

Which verification profile families this customer may onboard through. Set explicitly at creation — from the request when supplied, otherwise a snapshot of the application's families at that moment — and thereafter changed only by an explicit update, so it does not follow later changes to the application. Always a subset of the application's families. Distinct from verificationProfiles, which reports the evaluated profiles and their statuses.

Opções disponíveis:
a,
b,
c,
d
Exemplo:
id
string
obrigatório

Customer ID

Exemplo:

"customer_f31121c389624d3697cbf3ea8830b7a4"

tosStatus
enum<string>
obrigatório

Customer Terms of Service acceptance status (incomplete | pending | approved).

Opções disponíveis:
incomplete,
pending,
approved
Exemplo:

"incomplete"

type
enum<string>
obrigatório

Customer type

Opções disponíveis:
individual
Exemplo:

"individual"

updatedAt
string
obrigatório

ISO 8601 formatted customer update timestamp

Exemplo:

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

verificationProfiles
object[]
obrigatório

The evaluated verification profiles for this customer and their statuses — what the customer is being assessed against right now, as opposed to enabledVerificationProfiles, which says which families they are permitted to use. 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:
dateOfBirth
string

The customer's date of birth in YYYY-MM-DD format (individual customers only).

Exemplo:

"1990-01-15"

email
string

Customer email address

Exemplo:

"jane.smith@example.com"

firstName
string

Customer first name (individual customers only)

Exemplo:

"Jane"

lastName
string

Customer last name (individual customers only)

Exemplo:

"Smith"

meta
object
personalInformation
object

Personal information for an individual customer, echoed back from the most recent submission. The tax identification number is omitted from responses for privacy.

phone
string

Customer phone number

Exemplo:

"+14155550123"

statusDetails
object

Additional context on why the customer's verification reached its current status.

Exemplo:
Última modificação em 16 de novembro de 2026