POST
/
v1
/
initiate
/
otplink

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.

If you need to send the SMS OTP LINK to users outside India then please reach out to us on support to activate it.

Authorizations

clientId
string
header
required
clientSecret
string
header
required

Body

application/json
channels
enum<string>[]
required

An array specifying the channels through which the OTP link will be sent. Supported channels include WHATSAPP, SMS, and VIBER. The smart authentication flow will be enabled if multiple channels are provided.

Available options:
WHATSAPP,
SMS,
VIBER
phoneNumber
string
required

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

redirectURI
string
required

The URI to redirect the user after verification.

expiry
integer

The expiration time for the OTP in seconds.

metadata
object

Additional metadata for the request.

otpLength
enum<integer>

The length of the OTP, either 4 or 6.

Available options:
4,
6

Response

200 - application/json
requestId
string

The unique identifier for the OTP link request.