Send OTP

Send an OTP (One-Time Password) to a user’s mobile number or email address.

Features:

• SMS delivery via your own sender name or Authentica’s default sender
• Email delivery via your own email or Authentica’s default email
• Multiple templates available

Note: Check Application settings on Authentica dashboard to set default values for OTP options.

POST /send-otp

cURL

sms

curl --request POST \ --url https://api.authentica.sa/api/v2/send-otp \ --header 'Content-Type: application/json' \ --header 'X-Authorization: <api-key>' \ --data ' { "method": "sms", "phone": "[phone]", "template_id": 31 } '

200

{
  "success": true,
  "data": null,
  "message": "OTP send successfully"
}

Authorizations

X-Authorization · string · header · required

API key for authentication. Get Your API Key

Body

application/json

method · enum<string>

Delivery method for the OTP. Required if no default channel is configured.

Available options: sms, whatsapp, email

Example:

"sms"

phone · string

Valid international phone number. Required if method is sms or whatsapp.

Pattern: ^\+[1-9]\d{1,14}$

Example:

"[phone]"

email · string<email>

Valid email address. Required if method is email.

Example:

"[e-mail]"

template_id · integer · default: 1

Template ID for the OTP message. Default is 1.

Example:

31

Response

200

application/json

OTP sent successfully

success · boolean

Example:

true

data · object

message · string

Example:

"OTP send successfully"