Request OTP

import requests url = "https://karibu.briq.tz/v1/otp/request" payload = { "phone_number": "<string>" } headers = { "X-API-Key": "<api-key>", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)

const options = { method: 'POST', headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'}, body: JSON.stringify({phone_number: '<string>'}) }; fetch('https://karibu.briq.tz/v1/otp/request', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));

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 | 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"

sender_id

string | null

Sender ID shown to the recipient. SMS only — silently ignored on call and whatsapp. Defaults to the platform-configured OTP_DEFAULT_SENDER_ID.

Example:

"BRIQ OTP"

otp_length

integer

default:6

Length of OTP code

Example:

6

minutes_to_expire

integer

default:10

OTP expiry time in minutes

Example:

10

delivery_method

enum<string>

default:sms

Delivery channel: sms (default), call (TTS), or whatsapp (uses platform-managed briq_otp template; sender resolution is automatic).

Available options:

sms,

call,

whatsapp

Examples:

"sms"

"call"

"whatsapp"

message_template

string | null

Custom OTP message template. Must contain {code}; {expiry} is also substituted. SMS only — silently ignored on call and whatsapp. WhatsApp wording is fixed by the approved briq_otp Meta template.

Example:

"Your OTP is {code}"

callback_url

string<uri> | null

Optional HTTPS URL to receive async flake lifecycle webhooks (e.g. flake.verified) for this request. Active for this OTP's lifetime. Must not resolve to private or loopback addresses.

Example:

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

callback_secret

string | null

Optional shared secret for HMAC signing (X-Briq-Signature) on callbacks to callback_url.

Response

Successful Response

success

boolean

required

message

string

required

data

Data · object | null

status_code

integer

default:200

Overview

Endpoints

Authorizations

Headers

Body

Response