Skip to main content
POST
Verify OTP

Authorizations

X-API-Key
string
header
required

Headers

X-API-Key
string
required

Body

application/json
phone_number
string
required

Recipient's phone number, E.164 digits-only (no '+', e.g. 255712345678)

Example:

"255712345678"

code
string
required

OTP code to verify

Example:

"123456"

app_key
string | null

Optional. Omit when your X-API-Key is bound to a developer app. Legacy unbound keys may send this or use the X-App-ID header instead.

Example:

"devapp_123456"

callback_url
string<uri> | null

Optional HTTPS callback override if the URL was not set on request/resend, or to replace it for this verify. Triggers async flake.verified or flake.failed webhooks on outcome.

Example:

"https://api.example.com/briq/otp-events"

callback_secret
string | null

Optional signing secret override for callback_url on verify. When omitted, the secret from request/resend is reused if available.

Response

Successful Response

success
boolean
required
message
string
required
data
Data · object | null
status_code
integer
default:200