OTP Integration
The OTP (One-Time Password) API offer flow is a server-to-server verification method commonly used in Mobile Value-Added Services (mVAS) campaigns. These campaigns provide additional services beyond basic calls and SMS, such as entertainment, alerts, and data services.
Using OTP verification helps:
Improve lead quality
Reduce fraud
Increase overall campaign reliability
How OTP API Works
Generate OTP
When a user submits their mobile number on a landing page, a unique, time-bound OTP is generated.
The OTP is delivered via an API call to the user and this action is recorded as a click in Offer18.
Verify OTP
The user enters the OTP received on their mobile device.
The OTP is validated via an API call and this is recorded as a conversion in Offer18.
To setup OTP Integration follow the below steps:
Navigate to Integration » OTP Integration
In "Credentials" section, Define "Name" for the integration
Add advertiser's "OTP Send API URL" » add keys and values for API endpoint
Add "OTP Verify API URL" » add keys and values for API endpoint
Submit & Next
For the "OTP Send API URL", {msisdn} is a mandatory value. For the "OTP Verify API URL", both {msisdn} and {otp} are mandatory values. If the advertiser’s API requires any additional mandatory parameters, add them to the respective API calls as needed.
Generate OTP API endpoints for the affiliates
After submitting the API setup, proceed to "Affiliate API Endpoints".
Add "Page Title" for the landing page.
Select Affiliate ID
Click "Generate" for OTP API endpoints and landing page script
API access must be enabled for the affiliate.
OTP Landing Page Script
Download the landing page script and share it with your affiliate so they can integrate it into their application or repository. If they do not have a dedicated landing page, they can use this script directly as part of their existing setup. The integration requires minimal configuration.
The script automatically injects the Affiliate ID, API credentials, and other required parameters based on the selected affiliate id in configuration. All transactional data such as MSISDN and OTP are dynamically populated at runtime during the OTP flow, ensuring seamless communication between the landing page and the OTP APIs.
The script will be downloaded in PHP.
Last updated