Saltar al contenido principal
Create Customer via Link
curl --request POST \
  --url https://api.spherepay.co/v2/customer/kyc-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "individual",
  "email": "jane.smith@example.com",
  "phone": "+14155550123",
  "address": {
    "line1": "233 South Wacker Drive",
    "city": "Chicago",
    "country": "USA",
    "line2": "Suite 4700",
    "state": "IL",
    "postalCode": "60606"
  }
}
'
{
  "customerId": "customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
  "url": "https://in.sumsub.com/websdk/p/sbx_uq30ag1ov7oHZhmx",
  "expiresAt": "2026-03-09T20:46:31.305Z"
}
Usa este endpoint para crear un cliente y generar un link KYC alojado en una sola solicitud. En lugar de crear primero el cliente y luego solicitar un link por separado, proporcionas aquí el tipo, email, teléfono y dirección del cliente, y la respuesta devuelve el ID del nuevo cliente junto con una URL de verificación alojada con tiempo limitado. Redirige al cliente a esta URL para completar sus verificaciones de identidad con el proveedor de verificación.
Los clientes creados mediante este flujo de link de incorporación solo pueden gestionarse con los endpoints de links de incorporación — no son compatibles con los flujos directos de incorporación de la API. Del mismo modo, los clientes incorporados a través de los otros flujos de la API no pueden usarse con los endpoints de links de incorporación.
La URL devuelta expira en el momento indicado por expiresAt — por defecto, 4 semanas (28 días) después de su creación. Este valor por defecto puede cambiar sin previo aviso, así que confía siempre en expiresAt en lugar de asumir una duración fija. Si el link expira antes de que el cliente complete la verificación, genera uno nuevo con Regenerar Link KYC usando el customerId de esta respuesta.

Autorizaciones

​
Authorization
string
header
requerido

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

Cuerpo

application/json
​
type
enum<string>
requerido

The type of customer to onboard.

Opciones disponibles:
individual,
business
Ejemplo:

"individual"

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

​
address
object
requerido

The customer's address. For individual customers this is the residential address; for business customers this is the registered business address.

Respuesta

​
customerId
string
requerido

The ID of the customer the KYC link belongs to

Ejemplo:

"customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7"

​
url
string
requerido

Hosted KYC URL

Ejemplo:

"https://in.sumsub.com/websdk/p/sbx_uq30ag1ov7oHZhmx"

​
expiresAt
string
requerido

ISO 8601 formatted date and time of the KYC URL expiration. By default, links expire 4 weeks (28 days) after creation, but this default may change without notice — always rely on this field rather than assuming a fixed duration.

Ejemplo:

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

Última modificación el 2 de julio de 2026