Bienvenido a la documentación oficial de las APIs de JAAK, una plataforma integral de verificación de identidad y autenticación biométrica diseñada para ofrecer soluciones de seguridad avanzadas y experiencias de usuario excepcionales.

¿Qué es JAAK?

JAAK es una plataforma de verificación de identidad basada en inteligencia artificial que proporciona servicios de KYC (Know Your Customer), autenticación biométrica y verificación de documentos. Nuestra arquitectura de microservicios permite integrar soluciones de identidad robustas y escalables en sus aplicaciones y sistemas empresariales.

Arquitectura de APIs

Las APIs de JAAK están organizadas en módulos especializados que cubren diferentes aspectos de la verificación de identidad:

🔐 KYC (Know Your Customer)

Gestión de sesiones: Creación y administración de sesiones de verificación
Procesamiento de documentos: Análisis y validación de documentos de identidad
Verificación biométrica: Liveness detection y análisis facial
Verificación de identidad: Comparación de rostro 1 a 1
Consultas Blacklist: Consulta de datos ante entidades gubernamentales

📄 Document

Análisis de documentos: Extracción de datos de documentos oficiales
Validación de autenticidad: Verificación de características de seguridad
Soporte multipaís: Compatibilidad con documentos de múltiples países

🧬 Liveness

Detección de vida: Verificación de presencia real del usuario
Anti-spoofing: Protección contra ataques de suplantación
Análisis facial: Procesamiento de características biométricas faciales

🌐 Servicios Adicionales

Blacklist: Gestión de listas de usuarios restringidos
Geolocalización: Servicios de ubicación y contexto
RFC/CURP: Validación de documentos fiscales mexicanos
Passwordless: Autenticación sin contraseñas

Características Principales

⚡ Alto Rendimiento

Arquitectura de microservicios distribuida
Procesamiento asíncrono con respuestas en tiempo real
Escalabilidad horizontal automática

🔒 Seguridad Avanzada

Encriptación end-to-end de datos biométricos
Tokens JWT con expiración configurable
Middleware de protección DDOS integrado

🌍 Cobertura Global

Soporte para documentos de múltiples países
APIs multiidioma (español, inglés, francés)
Compliance con regulaciones internacionales

🛠 Facilidad de Integración

APIs RESTful con documentación completa
SDKs disponibles para múltiples lenguajes
Ambientes de sandbox para desarrollo y pruebas

Ambientes Disponibles

Ambiente	URL Base	Propósito
Producción	`https://services.api.jaak.ai`	Uso en aplicaciones en vivo
Sandbox	`https://sandbox.api.jaak.ai`	Desarrollo y pruebas

Autenticación

JAAK soporta múltiples métodos de autenticación según el tipo de integración:

API Keys

Authorization: Bearer YOUR_API_KEY

Ideal para integraciones server-to-server y aplicaciones empresariales.

Access Token(KYC)

Authorization: Bearer USER_SESSION_TOKEN

Para flujos KYC específicos con duración limitada (máximo 15 minutos) al intercambiar por un shortKey ShortKey.

Códigos de Respuesta Estándar

Código HTTP	Descripción	Uso Típico
200	Éxito	Operación completada correctamente
400	Solicitud incorrecta	Error en parámetros o formato
401	No autorizado	Token inválido o expirado
403	Prohibido	Permisos insuficientes
404	No encontrado	Recurso no existe
429	Demasiadas solicitudes	Rate limit excedido
500	Error interno	Error del servidor

Manejo de Errores

Todas las APIs de JAAK devuelven errores en un formato consistente:

{
  "eventId": "uuid-del-evento",
  "statusCode": 400,
  "errorCode": "JAAK_ERROR_CODE",
  "message": "Descripción del error"
}

Códigos de Error Comunes

Código	Descripción	Acción Recomendada
`KYC01`	Header requerido faltante	Verificar headers obligatorios
`KYC07`	Short-key no válido	Generar nuevo short-key
`KYC08`	Short-key expirado	Renovar autenticación
`DOC01`	Imagen no válida	Verificar formato y calidad

Rate Limiting

Para garantizar la estabilidad del servicio, las APIs implementan límites de velocidad:

APIs KYC: 100 solicitudes por minuto por API key
APIs: 200 solicitudes por minuto por API key

Primeros Pasos

1. Obtener Credenciales

Contacte a soporte@jaak.ai para solicitar:

API Keys de sandbox y producción
Configuración de productos específicos

2. Configurar Ambiente de Desarrollo

# Variables de entorno recomendadas
export JAAK_API_URL="https://sandbox.api.jaak.ai"
export JAAK_API_KEY="your_sandbox_api_key"
export JAAK_LANGUAGE="es"

Recursos Adicionales

🛠 Herramientas de Desarrollo

Colecciones Postman disponibles: KYC Postman
SDKs para JavaScript, iOS y Kotlin Android : Herramientas JAAK
Webhooks para notificaciones: Webhook JAAK KYC

🤝 Soporte

Próximos Pasos

¡Está listo para comenzar a integrar las APIs de JAAK! Recomendamos:

Revisar la documentación específica del módulo que planea implementar
Configurar su ambiente de sandbox para pruebas iniciales
Implementar el flujo básico de KYC o autenticación biométrica
Realizar pruebas exhaustivas antes de pasar a producción

Para consultas específicas o soporte técnico personalizado, no dude en contactar a nuestro equipo de desarrollo.