POST
/
auth
/
v1
/
initiate
/
otp
curl --request POST \
  --url https://auth.otpless.app/auth/v1/initiate/otp \
  --header 'Content-Type: application/json' \
  --header 'clientId: <api-key>' \
  --header 'clientSecret: <api-key>' \
  --data '{
  "email": "your@email.com",
  "expiry": 30,
  "otpLength": 4,
  "channels": [
    "EMAIL"
  ],
  "metadata": {
    "key1": "Data1",
    "key2": "Data2"
  }
}'
{
  "requestId": "unique_request_id"
}

This API is accessible exclusively to users subscribed to the OTPless Pro plan. Ensure you have an active OTPless Pro Plan subscription to utilize this feature.

Authorizations

​
clientId
string
header
required
​
clientSecret
string
header
required

Body

application/json
​
email
string
required

The phone number to which the OTP will be sent, including country code.

Example:

"your@email.com"

​
channels
enum<string>[]
required

An array specifying the channels through which the OTP will be sent. Supported channels include WHATSAPP, SMS, VOICE_CALL, and VIBER. If multiple channels are provided, a smart authentication flow is activated, which automatically falls back to the next channel in the array if the OTP delivery fails or if the user does not verify within the expected time frame.

Available options:
EMAIL
Example:
["EMAIL"]
​
expiry
integer

The expiration time for the OTP in seconds.

Example:

30

​
otpLength
enum<integer>

The length of the OTP, either 4 or 6.

Available options:
4,
6
Example:

4

​
metadata
object

Additional metadata for the request.

Example:
{ "key1": "Data1", "key2": "Data2" }

Response

200
application/json
OTP initiated successfully
​
requestId
string

The unique identifier for the OTP request.

Example:

"unique_request_id"

Was this page helpful?