The OTP methods are used to generate, verify, and export one-time password (OTP) data for secure authentication workflows.

OTPs are commonly used for two-factor authentication, login verification, and secure transactions. To learn more about how OTPs can be implemented in your application, refer to the Quick Start Guide - One-Time Password.

Before using these APIs, ensure you have followed the instructions to set up the required One-Time Password Integration.

See below for a brief description of the available OTP API methods:

  • OTP Generate API: Generate a one-time password (OTP) and send it to a specified mobile number via SMS.
  • OTP Verify API: Verify the OTP entered by the user against the previously generated code.
  • OTP History List: Retrieve OTP history records based on specified input parameters for detailed reporting and analysis.
  • OTP History Info: Retrieve detailed information about a specific OTP log, including delivery and verification timestamps.