Skip to content

Send OTP methods

Use these methods to send an OTP code to the holder after enrollment.

The OTP delivery channel depends on the otpType set during enrollment:

  • SMS — OTP sent via SMS to the holder's mobile number
  • EMAIL — OTP sent via email
  • WHATSAPP — OTP sent via WhatsApp to the holder's mobile number (requires LRA authorization and template configuration)

Methods:


Response

Both methods return an empty body on success.

HTTP StatusDescription
200OTP sent successfully. Response body is empty

Errors

All errors below return HTTP 500.

Error codeDescription
2Some required fields are missing
6Generic exception — internal exception
62The certIdOtp is not valid
66The device OTP is not active
71The device OTP is disabled
85The deviceCode is not valid
99OTP was not sent
100The mobile phone number is not valid
101SMS blocked by the watchlist
102The email address is not valid
103The OTP service has exceeded the timeout
138The device OTP is not an SMS OTP device
231OTP is blocked
241LRA not authorized to use this OTP type
240No email template configured for this LRA

For authentication errors, see Authentication.
For details on how to handle errors, see How to handle errors.