Saltar al contenido principal
Advance a sandbox customer
Este endpoint funciona solo contra https://api.sandbox.spherepay.co. Reporta un resultado de verificación simulado para un cliente, porque sandbox nunca llama a los proveedores de verificación. approved aprueba todos los perfiles de verificación que tiene el cliente (A, y C y D cuando aplican), de modo que el cliente puede usar todas las rutas que esos perfiles habilitan; rejected los rechaza todos. Pasa profile para avanzar un solo perfil: A (kyc_profile_a, kyb_profile_a), o aprobar C o D (kyc_profile_c, kyc_profile_d, kyb_profile_c, kyb_profile_d) mientras los demás quedan como están. Los clientes incorporados mediante el link de KYC alojado se avanzan de la misma manera. Avanzar al resultado actual no cambia nada, y un cliente rechazado no puede ser aprobado (422).

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de ruta

id
string
requerido

Cuerpo

application/json
outcome
enum<string>
requerido

The verification outcome the provider reports for the customer.

Opciones disponibles:
approved,
rejected
Ejemplo:

"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.

Opciones disponibles:
kyc_profile_a,
kyb_profile_a,
kyc_profile_c,
kyb_profile_c,
kyc_profile_d,
kyb_profile_d
Ejemplo:

"kyc_profile_a"

Respuesta

Response containing information about an individual customer.

createdAt
string
requerido

ISO 8601 formatted customer creation timestamp

Ejemplo:

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

enabledVerificationProfiles
enum<string>[] | null
requerido

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.

Opciones disponibles:
a,
b,
c,
d
Ejemplo:
id
string
requerido

Customer ID

Ejemplo:

"customer_f31121c389624d3697cbf3ea8830b7a4"

tosStatus
enum<string>
requerido

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

Opciones disponibles:
incomplete,
pending,
approved
Ejemplo:

"incomplete"

type
enum<string>
requerido

Customer type

Opciones disponibles:
individual
Ejemplo:

"individual"

updatedAt
string
requerido

ISO 8601 formatted customer update timestamp

Ejemplo:

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

verificationProfiles
object[]
requerido

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.

Ejemplo:
dateOfBirth
string

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

Ejemplo:

"1990-01-15"

email
string

Customer email address

Ejemplo:

"jane.smith@example.com"

firstName
string

Customer first name (individual customers only)

Ejemplo:

"Jane"

lastName
string

Customer last name (individual customers only)

Ejemplo:

"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

Ejemplo:

"+14155550123"

statusDetails
object

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

Ejemplo:
Última modificación el 16 de noviembre de 2026