Registro Biométrico con ID

Registra un usuario nuevo con verificación documental — OCR del documento más comparación facial 1:1 contra la foto del documento.

Instalación del SDK

Antes de integrar, instala el SDK en Getting Started → Instalar el SDK →

POST /api/kyc/onboard
Cuándo usar este flujo

Apertura de cuenta, registro de usuario, activación de tarjetas — cualquier caso de onboarding donde necesitas verificar la identidad del usuario contra su documento físico.

Flujo

1

Validación de entorno

Controles RASP previos a la captura.

2

Captura facial

Captura del rostro con prueba de vida.

3

Captura de documento

OCR del documento de identidad y comparación facial 1:1 contra la foto del documento.

4

Datos cifrados

El SDK devuelve template + payload (rostro + datos del documento).

5

Solicitud de onboarding

Tu backend reenvía template + payload + DNI al endpoint /api/kyc/onboard.

Llamada del SDK

Kotlin
// Onboarding flow — also scans the ID document
SmartId
    .getInstance()
    .captureBiometric(getApplicationContext())
    .withDocument()
    .onSuccess { template, payload ->
        // template + payload include the face capture
        // AND the OCR data from the document
    }
    .onFailure { message, errorCode ->
        // capture failed — surface a retry to the user
    }
    .start()
Swift
SID.shared.startLocation()

SID.shared
    .captureBiometric()
    .withDocument()
    .onSuccess(success: { template, payload in
        // face + document captured
    })
    .onFailure(failure: { message, errorCode in
        // capture failed
    })
    .start()

Llamada al backend

cURL
curl -X POST https://<api-url>/api/kyc/onboard \\
  -H "Content-Type: application/json" \\
  -H "X-Api-Key: <your-api-key>" \\
  -d '{
    "User": "[email protected]",
    "DNI": "23154613543134",
    "Template": "<template from SDK>",
    "PayLoad": "<payload from SDK>",
    "OverWrite": "true"
  }'

Cuerpo de la solicitud

CampoTipoRequeridoDescripción
UserstringRequeridoIdentificador único del usuario
DNIstringRequeridoNúmero del documento de identidad
TemplatestringRequeridoTemplate biométrico cifrado generado por el SDK
PayLoadstringRequeridoDatos del documento + metadata generados por el SDK
OverWritestringOpcional"true" para reemplazar un registro existente del usuario

Códigos de respuesta

CódigoSignificado
200Onboarding exitoso
403User o DNI no pueden ser nulos o vacíos
407Validación del template falló
408Usuario ya enrolado
412Formato de template inválido
413Similitud rostro↔documento por debajo del umbral
420No se obtuvieron datos válidos del documento
421Falló la generación del template desde la imagen del documento
425/426Timestamp inválido / template expirado
500/701Error interno / al llamar al servicio