api

En este apartado explicaremos cómo hacer una integración de JAAK KYC para API. Antes de comenzar es necesario haber consultado la sección JAAK KYC ya que será necesario contar con un Short Key.

Este diagrama ilustra un flujo de verificación de identidad (KYC) integrado mediante API. A través de un intercambio de claves, se obtiene un BearerToken que autoriza y agrupa las llamadas por sesión KYC (shortKey). En el frontend, los componentes del JAAK SDK se encargan de guiar al usuario para una captura óptima de sus documentos y datos biométricos, emitiendo los resultados en formato Base64. Finalmente, el backend recibe esta información y orquesta las llamadas a los productos de JAAK (como OCR, Liveness y verificación de documentos).

Requisitos

Todas las llamadas API que realizaremos a continuación será mediante la arquitectura REST (Representational State Transfer), con el estándar web HTTP (HyperText Transfer Protocol) y firmando la comunicación con el formato JSON (JavaScript Object Notation).

Recomendamos tener un conocimiento por lo menos básico de estos 3 conceptos para poder continuar con esta guía.

Headers comunes

Todos los pasos del flujo (paso 1 al 9) comparten dos headers que se propagan a lo largo de la sesión:

HeaderCuándo enviarloOrigen
Authorization: Bearer <token>Pasos 1 y 2 con la API Key (JWT generado en la plataforma). Pasos 3 al 9 con el Access Token devuelto en el paso 2.API Key desde Plataforma JAAK; Access Token desde la respuesta de /v1/kyc/session.
traceparentRecomendado en todos los pasos a partir del paso 2.Header de respuesta del paso 2 (formato W3C Trace Context). Reenviarlo permite que JAAK correlacione todos los servicios de la sesión KYC en logs y métricas.

Mantener el traceparent consistente a lo largo del flujo es clave para que el equipo de soporte pueda diagnosticar incidencias por sesión sin ambigüedad. Si lo omites, las llamadas se procesarán igual pero los logs quedarán fragmentados.

Base URL

AmbienteURL base
Sandboxhttps://api.sandbox.jaak.ai/api
Producciónhttps://services.api.jaak.ai/api

Todos los paths (/v1/kyc/flow, /v1/kyc/session, /v3/document/verify, /v4/document/extract, /v2/blacklist/investigate, /v1/liveness/verify-and-bestframe, /v2/oto/verify, /v1/kyc/session/finish) son relativos a esta base.