Skip to main content
Verify API zpracovává kompletní OTP životní cyklus: posílá 6místný kód na telefonní číslo přes SMS, ověřuje kód, který váš uživatel zadá, a volitelně generuje kryptografický HMAC proof, který vašemu backendu umožňuje potvrdit validaci offline — bez dalšího autentizovaného API volání.

​
Základní URL

​
Autentizace

Všechny endpointy vyžadují váš API klíč v hlavičce požadavku X-API-Key.
Výjimka: POST /v1/verify-proof nevyžaduje autentizaci. Sam otný HMAC proof slouží jako credentiál.

​
Jak to funguje

  1. POST /v1/validations — Předejte telefonní číslo. API posílá 6místný kód přes SMS a vrací token, který použijete v následujících voláních.
  2. Uživatel obdrží SMS — Váš uživatel přečte 6místný kód ze svého telefonu.
  3. POST /v1/validations//verify — Předejte kód, který uživatel zadal. Při úspěchu obdržíte ověřené telefonní číslo a volitelný HMAC proof.
  4. Ověření HMAC proof (volitelné) — Předejte proof a přidružená pole na POST /v1/verify-proof (nevyžaduje autentizaci) nebo PATCH /v1/validations/{token} k potvrzení, že je validace autentická na vašem backendu.

​
Stavy validace

Každá validační session prolézá následující stavy:

​
HMAC offline proof

Když má váš účet nakonfigurován verificationSecret, každá validační odpověď obsahuje pole proof s HMAC podpisem vypočítaným z telefonního čísla, tokenu, kódu a timestamp pomocí vašeho tajemství. Můžete předat těchto čtyř polí plus proof na POST /v1/verify-proof — který nevyžaduje autentizaci — k potvrzení, že ověření skutečně proběhlo. To je užitečné pro mikroslužby, edge funkce nebo jakýkoli backend, který by neměl držet váš API klíč.

​
Rate limiting

API aplikuje dvě úrovně rate limitingu:
  • Per účet (tenant) — strop na celkový počet validací napříč všemi telefonními čísly na vašem účtu.
  • Per telefonní číslo — strop na počet ověření jednoho čísla v rolling okně.
Požadavky překračující některý limit dostanou odpověď 429 s chybovým kódem TENANT_RATE_LIMIT nebo PHONE_RATE_LIMIT.

​
Souhrn endpointů

Jednotlivé endpointy — s parametry, těly požadavků a příklady — najdete v postranním panelu této sekce. Jsou generovány přímo z OpenAPI specifikace.