Skip to main content
POST

Autorizace

​
X-API-Key
string
header
povinné

Your tenant's API key

Tělo

application/json
​
phoneNumber
string
povinné

The phone number to validate (digits only, including country code)

Pattern: ^[1-9]\d{6,14}$
Příklad:

"1234567890"

​
turnstileToken
string

Turnstile verification token (required if tenant has requireTurnstile enabled)

Příklad:

"0.abcdefghijklmnopqrstuvwxyz"

​
payload
object

Optional custom payload to attach to the validation

Příklad:

Odpověď

Validation started successfully

​
token
string
povinné

Unique validation token to use for verification

Příklad:

"val_7af7215261b8497cb355e617b13f4ef2"

​
status
enum<string>
povinné

Current status of the validation

Dostupné možnosti:
pending,
code_sent,
verified,
failed,
expired
Příklad:

"pending"

​
expiresAt
string<date-time>
povinné

When this validation expires (typically 10 minutes)

Příklad:

"2024-01-01T00:10:00.000Z"

​
timestamp
string<date-time>
povinné

When this validation was started (used for HMAC verification)

Příklad:

"2024-01-01T00:00:00.000Z"

​
proof
string

HMAC proof for offline verification (only if tenant has verificationSecret)

Příklad:

"a2c4e6f8b0d2e4f6a8c0e2f4b6d8f0a2c4e6f8b0d2e4f6a8c0e2f4b6d8f0a2"