Registro Biométrico
Registra el rostro del usuario cuando ya su identidad es confiable en tu sistema.
Instalación del SDK
Antes de integrar, instala el SDK en Getting Started → Instalar el SDK →
POST
/api/kyc/enroll Flujo
1
Validación de entorno
El SDK ejecuta los controles RASP (dispositivo, red, ubicación) antes de iniciar la captura.
2
Captura facial
El componente de captura ejecuta prueba de vida (activa o pasiva) y genera el template biométrico.
3
Datos cifrados
El SDK devuelve template + payload cifrados al aplicativo bancario.
4
Solicitud de registro
Tu backend reenvía template + payload al endpoint /api/kyc/enroll.
Llamada del SDK
Kotlin
// Just before submitting enrollment
SmartId
.getInstance()
.captureBiometric(getApplicationContext())
.onSuccess { template, payload ->
// template: encrypted face template
// payload: SDK metadata
// forward both to your backend
}
.onFailure { message, errorCode ->
// capture failed — surface a retry to the user
}
.start()Swift
SID.shared.startLocation()
SID.shared
.captureBiometric()
.onSuccess(success: { template, payload in
// template: encrypted face template
// payload: SDK metadata
})
.onFailure(failure: { message, errorCode in
// capture failed — surface a retry to the user
})
.start()Llamada al backend
cURL
curl -X POST https://<api-url>/api/kyc/enroll \\
-H "Content-Type: application/json" \\
-H "X-Api-Key: <your-api-key>" \\
-d '{
"User": "[email protected]",
"Template": "<template from SDK>",
"PayLoad": "<payload from SDK>",
"OverWrite": "true"
}'Cuerpo de la solicitud
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
User | string | Requerido | Identificador único del usuario |
Template | string | Requerido | Template biométrico cifrado generado por el SDK |
PayLoad | string | Requerido | Metadata adicional generada por el SDK |
OverWrite | string | Opcional | "true" para reemplazar un registro existente del usuario |
Códigos de respuesta
| Código | Significado |
|---|---|
200 | Registro exitoso |
403 | User no puede ser nulo o vacío |
407 | Validación del template falló |
408 | Usuario ya enrolado (envía OverWrite=true para reemplazar) |
412 | Formato de template inválido |
425/426 | Timestamp inválido / template expirado |
500/701 | Error interno / al llamar al servicio |
Eliminar registro (un-enroll)
Elimina el registro biométrico del usuario para que pueda volver a enrolarse desde cero. Útil para reseteos solicitados por el cliente o tras cambios en el dispositivo.
POST
/api/kyc/unenroll cURL
curl -X POST https://<api-url>/api/kyc/unenroll \\
-H "Content-Type: application/json" \\
-H "X-Api-Key: <your-api-key>" \\
-d '{ "User": "[email protected]" }'Códigos de respuesta
| Código | Significado |
|---|---|
200 | Eliminación exitosa |
403 | User no puede ser nulo o vacío |
406 | Usuario no encontrado |
410 | Canal del usuario no encontrado |
500/701 | Error interno / al llamar al servicio |