Skip to main content
POST
Create a voice-authentication challenge

Authorizations

Authorization
string
header
required

Your API key from the Wave dashboard. Sandbox keys start sk_sandbox_; production keys start sk_live_. Send as Authorization: Bearer <key>. Some endpoints require a production key and specific scopes.

Headers

Idempotency-Key
string

Repeat-safe key; a retry returns the same challenge without a second call.

Body

application/json
phone_number
string
required

E.164 (+9665…) — the number Wave dials.

locale
enum<string>
default:ar
Available options:
ar,
en
context
object

Non-secret descriptor injected into the prompt.

assurance
enum<string>
default:standard
Available options:
standard,
number_match
ttl_seconds
integer
default:90
Required range: 30 <= x <= 180
retry_on_no_answer
integer
default:0
Required range: 0 <= x <= 2
callback_url
string<uri>
idempotency_key
string
metadata
object

Response

Challenge created; call placed

challenge_id
string
state
string
Example:

"initiated"

expires_at
string<date-time>
match_digits
string

number_match only — display these to your user.