Saltar al contenido principal
Create a Customer
Antes de poder iniciar cualquier transferencia, debes crear un registro de cliente (customer) en SpherePay. Este endpoint registra un cliente individual o empresarial y devuelve un objeto de cliente con un ID único y un array verificationProfiles que rastrea el estado de completitud de KYC/KYB. Debes especificar type desde el inicio — no puede cambiarse después de la creación. Los clientes individuales residentes en la región EEA+ y las empresas constituidas en EEA+ tienen campos adicionales que deben estar presentes antes de la verificación. Esos campos son opcionales en la creación. Consulta Residentes EEA+ y Empresas EEA+.

Autorizaciones

Authorization
string
header
requerido

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

Cuerpo

application/json
email
string<email>
requerido

The customer email address

Maximum string length: 254
Ejemplo:

"jane.smith@example.com"

phone
string
requerido

The customer phone number in E.164 format

Pattern: ^\+(?:[0-9]){6,14}[0-9]$
Ejemplo:

"+14155550123"

type
enum<string>
requerido
Opciones disponibles:
individual
address
object

The customer's address. Deprecated — prefer addresses.

addresses
object[]

The customer's addresses. Individual customers support exactly one residential address. Provide either this field or the deprecated address field, not both.

Ejemplo:
dateOfBirth
string

The date string in YYYY-MM-DD format

Ejemplo:

"2026-01-01"

enabledVerificationProfiles
enum<string>[]

Restricts which verification profile families this customer may onboard through. Must be a subset of the families enabled on your application; supplying one that is not enabled is rejected with a 422. Omit the field to inherit the application's setting.

Minimum array length: 1
Opciones disponibles:
a,
b,
c,
d
Ejemplo:
firstName
string

The customer's legal first name.

Required string length: 1 - 100
Ejemplo:

"Jane"

ipAddress
string

The IP address the customer used to sign up. Required by some verification providers.

Ejemplo:

"203.0.113.4"

lastName
string

The customer's legal last name.

Required string length: 1 - 100
Ejemplo:

"Smith"

meta
object

Additional metadata associated with the customer

middleName
string

The customer's legal middle name.

Required string length: 1 - 100
Ejemplo:

"Anne"

personalExpectedActivity
Personal Expected Activity · object

The individual customer's expected transaction activity. Only accepted on individual customers.

personalInformation
object

Personal information including tax identification details for individual customers. When any tax identification field is provided, all tax identification fields (number, type, country) and address are required. Please refer to the Individual Verification Criteria for the full list of reference.

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 27 de agosto de 2026