Skip to main content
POST
Send a phone verification code

Authorizations

segmnt_session
string
cookie
required

Dashboard session cookie, set after SSO sign-in.

Body

application/json
phone
string
required

A Saudi or GCC mobile number. Stored only as a salted hash.

Examples:

"0512345678"

"+966512345678"

"+971501234567"

country
enum<string>

Country of a local phone (for example ae for 0501234567). Ignored when phone starts with a country code. Defaults to sa.

Available options:
sa,
ae,
kw,
qa,
bh,
om

Response

A code was sent.

challengeId
string
required
Example:

"phc_8fK2mQ"

phone
string
required

The number with its middle digits masked.

Example:

"+96651****678"

expiresAt
string<date-time>
required
testCode
string

Present ONLY in the TEST environment (TEST_SINK=1), so the automated end-to-end test can finish the flow without a real SMS. Never present in production.