Telefonic verification by OTP

Description

Endpoint sending single-use passwords (OTP) using SMS and WhatsApp to check phone numbers as part of processes KYC.

Authentication

Bearer Token with API Kys format sk_live_ or sk_test_ followed by 40 alphanumeric characters.

good practice:

  • Store in environment variables
  • Never put them in front code
  • Rotate every 90 days

Endpoint

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

URL: https://api.jaak.mx

Parameters

Leaders

LeaderValueRequired
Content-Typeapplication / jsonYes
AuthorizationBearer + API KeyYes

Body

FieldTypeRequiredDescription
company_idstringYesCompany unique identifier
country_documentstringYesCode ISO (MEX, COL, ARG, CHL, PER, BRA)
phone_numberstringYesInternational format with prefix +

Telephone format: Include national code with symbol + No spaces and no scripts. Example: "+525512345678"

Response Codes

CodeDescription
200Success - Retort session_id
400Invalid / incomplete data or wrong phone format
401API Invalid or missing key
403API key without necessary permits
404company_id Unfound
429Rate limit - 5 applications / 10 min by phone, 100 / hour per company
500Server error

Example 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"
  }'

Integration Flow

  1. User enters phone number
  2. Valid format application
  3. Call /send-otp with Bearer Token
  4. JAAK send OTP through SMS and WhatsApp
  5. User gets 6-digit code (valid 5 minutes)
  6. User enters code into application
  7. Application verifies code using session_id
  8. Verification completed

Security details of OTP

  • Numeric code of 6 digits
  • Valid by 5 minutes
  • From a only use
  • Maximum 5 validation attempts by session_id
  • The session_id expires after validation or 10 minutes

Test environment

  • Sandbox URL: https://api-sandbox.jaak.mx
  • Test phone: +525500000001 (always successful)