Skip to main content
POST
/
v1
/
otp
/
verify
Verify OTP
curl --request POST \
  --url https://karibu.briq.tz/v1/otp/verify \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "phone_number": "<string>",
  "app_key": "<string>",
  "code": "<string>"
}
'
{
  "success": true,
  "message": "<string>",
  "data": {},
  "status_code": 200
}

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"

​
app_key
string
required

Developer app key

Example:

"devapp_123456"

​
code
string
required

OTP code to verify

Example:

"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
​
status_code
integer
default:200