Skip to main content
POST
/
v1
/
otp
/
request
Request Otp Developer App
curl --request POST \
  --url https://karibu.briq.tz/v1/otp/request \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '{
  "phone_number": "+255712345678",
  "app_key": "devapp_123456"
}'
{
  "success": true,
  "message": "<string>",
  "data": {},
  "status_code": 200
}

Headers

​
X-API-Key
string
required

Body

application/json
​
phone_number
string
required

Recipient's phone number

Example:

"+255712345678"

​
app_key
string
required

Developer app key

Example:

"devapp_123456"

​
sender_id
string | null

Sender ID for SMS (defaults to 'BRIQ OTP')

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
string
default:sms

Delivery method: sms or call

Example:

"sms"

​
message_template
string | null

Custom OTP message template

Example:

"Your OTP is {code}"

Response

Successful Response

​
success
boolean
required
​
message
string
required
​
data
object | null
​
status_code
integer
default:200
⌘I