Skip to main content
POST
Verify code

Authorizations

X-API-Key
string
header
required

Your tenant's API key

Path Parameters

token
string
required

The validation token returned from the start validation endpoint

Example:

"val_7af7215261b8497cb355e617b13f4ef2"

Body

application/json
code
string
required

The 6-digit verification code from SMS

Pattern: ^[0-9]{6}$
Example:

"123456"

Response

Code verified successfully

verified
boolean
required

Whether the verification was successful

Example:

true

phoneNumber
string

The verified phone number (only present if verified is true)

Example:

"1234567890"

token
string

The validation token (only present if verified is true)

Example:

"550e8400-e29b-41d4-a716-446655440000_abc123"

code
string

The verification code that was verified (only present if verified is true)

Example:

"123456"

timestamp
string<date-time>

When the validation was started (only present if verified is true)

Example:

"2024-01-15T10:30:00Z"

proof
string

HMAC proof for this verification (only present if verified is true and tenant has verificationSecret)

Example:

"86dd8444ed76402c93ce62497cb29a0d7af7215261b8497cb355e617b13f4ef2"

verifiedAt
string<date-time>

When the verification was completed (only present if verified is true)

Example:

"2024-01-15T10:31:15Z"