Documentación para desarrolladores de Certivant
Desarrolle con la API de Certivant — KYC, KYB, carga de documentos, sesiones alojadas y eventos de webhook.
Bienvenido a la documentación para desarrolladores de Certivant. Esta es la referencia técnica para integrar la plataforma KYC y KYB de Certivant en su propio producto.
Si lo que busca es cómo usar Certivant en el navegador, consulte la documentación para clientes. Este sitio asume que usted escribe código que se comunica con la API REST.
Qué puede crear
- Realizar una verificación de identidad (KYC) desde su propia aplicación: envíe un solicitante, recopile documentos mediante una sesión alojada o su propia interfaz, y reciba una decisión de aprobar, rechazar o escalar.
- Realizar una verificación empresarial (KYB): envíe los datos de la empresa, sus directores y sus beneficiarios finales (UBO), y compárelos con registros mercantiles y listas de sanciones.
- Recibir webhooks en tiempo real cuando una solicitud cambie de estado, se cargue un documento o finalice una comprobación.
- Gestionar solicitudes desde el panel mediante su propia automatización: los mismos endpoints alimentan la interfaz web de Certivant.
- Asociar solicitudes a sus propios clientes (modo socio): realice verificaciones para muchos clientes finales dentro de una misma organización, etiquete cada solicitud con un nombre de subtenant y un id externo, y filtre o enrute por ellos en la API y en los webhooks.
De un vistazo
| URL base | https://app.certivant.com/api/v1/kyc |
| Autenticación | Authorization: Bearer ck_live_… o ck_test_… (clave de API, por organización; las claves kyk_… anteriores siguen funcionando) |
| Tipo de contenido | application/json (o multipart/form-data para cargar documentos) |
| Límite de solicitudes | Según el plan: consulte Límites de solicitudes |
| Firma del webhook | X-Certivant-Signature-V2: t=…,v1=… (HMAC-SHA256 sobre timestamp.body, tolerancia de 300 s); consulte Verificación de firma |
| Referencia interactiva | Referencia de la API, o abra directamente /api/v1/docs; es pública y se genera a partir del esquema OpenAPI |
| Esquema OpenAPI | /api/v1/openapi.json: OpenAPI 3.1 público, sin inicio de sesión |
Un solo host, no un subdominio por cliente. En el servicio alojado, todas
las organizaciones comparten el mismo host, app.certivant.com. No existe
your-org.certivant.com, así que use app.certivant.com tal cual en estos
ejemplos. (Las instalaciones autoalojadas usan el dominio que haya configurado
el operador; certivant.com es el sitio de marketing, no la aplicación).
En la API, su organización se identifica por su clave de API, nunca por la
URL: la ruta base es /api/v1/kyc, sin ningún slug de organización. El slug
solo aparece donde una persona navega: el panel en /app/{org-slug} y los
enlaces de formularios y sesiones alojadas como /forms/{slug}. Un
dominio personalizado de marca blanca
puede hacer que esos enlaces para personas usen su propio dominio, pero el host
de la API no cambia.
La referencia interactiva y el esquema OpenAPI sin procesar son públicos:
no se necesita inicio de sesión ni clave de API, y describen solo los endpoints
de integración (/api/v1). Consulte
Referencia de la API.
Primeros pasos
Referencia
- Formularios: liste los formularios KYC y KYB del cliente para elegir con cuál ejecutar una verificación.
- Solicitudes KYC: crear, listar, consultar, enviar, decidir y reenviar.
- Solicitudes KYB: verificación empresarial con directores y UBO.
- Documentos: cargue documentos de identidad y obtenga URL de descarga firmadas.
- Sesiones alojadas: genere una URL de corta duración donde el solicitante completa el flujo.
- Lista de bloqueo: añada y elimine correos electrónicos, números de teléfono, números de documento y direcciones IP bloqueados, o bloquee el rostro, el dispositivo y la IP asociados a una verificación.
- Comprobación de edad: estime a partir de un selfi si una persona es lo suficientemente mayor, con un respaldo en la fecha de nacimiento del documento de identidad.
- Verificaciones reutilizadas: permita que un solicitante que ya superó una verificación de Certivant en otro lugar la reutilice con usted (personas físicas y empresas).
- Integrar en su sitio o aplicación: muestre una verificación en su propia página con una sola etiqueta de script, o en un WebView de React Native o Flutter.
- Referencia de la API (OpenAPI): el documento público OpenAPI 3.1 y la referencia interactiva.
- Verificación en vivo: programe, siga, reprograme o cancele una sesión de verificación de identidad en vivo dirigida por una persona, y reciba la decisión por webhook.
- Live ID Validation: inicio de sesión biométrico: compare el selfi en vivo de un usuario recurrente con el rostro de su verificación KYC.
- Servidor MCP: conecte un asistente de IA a su cola de verificación mediante el Model Context Protocol.
- Webhooks: registre una URL, verifique firmas y gestione los reintentos.
- Errores: códigos de error, correspondencia con los códigos de estado HTTP y forma de los campos de validación.
- Límites de solicitudes: cuotas, encabezados y estrategia de reintento.
- Esquemas: enumeraciones, valores de estado y formas de solicitud y respuesta que verá con frecuencia.