api

Verificación Telefónica por OTP

Descripción

Endpoint que envía contraseñas de un solo uso (OTP) vía SMS y WhatsApp para verificación de números telefónicos como parte de procesos KYC.

Autenticación

Bearer Token con API Keys formato sk_live_ o sk_test_ seguido de 40 caracteres alfanuméricos.

Buenas prácticas:

  • Almacenar en variables de entorno
  • Nunca exponer en código frontend
  • Rotar cada 90 días

Endpoint

POST /api/v1/kyc/phone/send-otp

Base URL: https://api.jaak.mx

Parámetros

Headers

HeaderValorRequerido
Content-Typeapplication/json
AuthorizationBearer + API Key

Body

CampoTipoRequeridoDescripción
company_idstringIdentificador único de la empresa
country_documentstringCódigo ISO del país (MEX, COL, ARG, CHL, PER, BRA)
phone_numberstringFormato internacional con prefijo +

Formato de teléfono: Incluir código de país con símbolo + sin espacios ni guiones. Ejemplo: "+525512345678"

Códigos de Respuesta

CódigoDescripción
200Éxito - Retorna session_id
400Datos inválidos/incompletos o formato de teléfono incorrecto
401API key inválida o faltante
403API key sin permisos necesarios
404company_id no encontrado
429Rate limit - 5 solicitudes/10 min por teléfono; 100/hora por empresa
500Error del servidor

Ejemplo cURL

curl -X POST "https://api.jaak.mx/api/v1/kyc/phone/send-otp" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <TU_ACCESS_TOKEN>" \
  -d '{
    "company_id": "5f8d0d55b54764421b7156c5",
    "country_document": "MEX",
    "phone_number": "+525512345678"
  }'

Flujo de Integración

  1. Usuario ingresa número de teléfono
  2. Aplicación valida formato
  3. Llamar /send-otp con Bearer Token
  4. JAAK envía OTP vía SMS y WhatsApp
  5. Usuario recibe código de 6 dígitos (válido 5 minutos)
  6. Usuario ingresa código en la aplicación
  7. Aplicación verifica código usando session_id
  8. Verificación completada

Detalles de Seguridad del OTP

  • Código numérico de 6 dígitos
  • Válido por 5 minutos
  • De un solo uso
  • Máximo 5 intentos de validación por session_id
  • El session_id expira después de validación o 10 minutos

Ambiente de Pruebas

  • URL Sandbox: https://api-sandbox.jaak.mx
  • Teléfono de prueba: +525500000001 (siempre exitoso)