Guía de Integración – Onboarding API
Última actualización Hace 10 meses
🧩 ¿Qué es?
La Onboarding API de Zenpli permite crear flujos de incorporación (onboarding) completamente personalizados para personas físicas y morales. A través de esta API puedes enviar atributos del usuario, monitorear su avance, aplicar reglas de validación y obtener un resultado final de verificación o decisión.
🎯 ¿Cuándo utilizarla?
Esta API es ideal cuando deseas:
Controlar completamente el proceso de onboarding desde tu propio frontend o backend.
Diseñar experiencias de registro progresivo (step-by-step).
Unificar flujos de KYC (personas) y KYB (empresas) en una sola plataforma.
Automatizar decisiones con lógica basada en reglas o scores.
⚙️ ¿Cómo funciona?
Creación de sesión de onboarding
Inicia un flujo de onboarding creando una nueva sesión para un usuario.
Envío de atributos
A lo largo del proceso, envías los datos recolectados del usuario (nombre, CURP, email, dirección, empresa, representantes, etc.).
Aplicación de lógica y validación
Zenpli aplica reglas pre configuradas: validación de datos, verificación de identidad, lógica de IFPE/KYC/KYB, etc.
Resultado final
Una vez completado el flujo, obtienes un resultado estructurado: aprobado, requiere revisión, rechazado, con flags y contexto adicional.
🛠️ Endpoints principales
Endpoint | Función |
| Crea una nueva sesión de onboarding |
| Envía o actualiza atributos del usuario |
| Consulta el estado actual del onboarding |
| Obtiene el resultado final del proceso |
🔐 Autenticación
Todos los endpoints requieren una API Key válida en el encabezado:
http Authorization: Bearer tu_api_key📌 Notas y consideraciones
La estructura del payload es flexible; puedes adaptar los atributos enviados según tu caso de uso.
Soporta múltiples tipos de usuario: individual, empresa, representante, apoderado, etc.
El flujo puede combinarse con módulos de verificación documental, listas negras, y lógica propia de negocio.