OTP API

OTP API can be used to generate and validate PINs in VAS campaigns, ensuring secure and efficient user authentication.

Common Parameters

Query

Type

Description

key

String

API Key

aid

Integer

Affiliate Id

mid

Integer

Your Advertiser MID

Generate OTP

POST https://api.offer18.com/api/af/otp_gen

Request Parameters

Body

Type

Description

type

string

Type of request

userId

string

User ID (under Partner)

msisdn

string

Mobile number (numeric)

partner

string

Partner name

https://api.offer18.com/api/af/otp_gen?key=000000000&aid=0000&mid=0000&msisdn=xxxxxxxx&partner=partnername&userId=xxxx

Success
{
  "status": "200",
  "response": "otp_sent",
  "data": "6xxxxx00f3fa55axxxxxxxxxx567a" // data[requestId] key and value return when patner api return in response 
} 

Failure
{     
  "status": "400",     
  "error": "invalid_user_credentials" 
}


Verify OTP

POST https://api.offer18.com/api/af/otp_verify

Request Parameters

Body

Type

Description

userId

string

User ID

msisdn

string

Mobile number

otp

string

OTP received by the user

partner

string

Partner name

request_id

string

Request ID for tracking

https://api.offer18.com/api/af/otp_verify?key=000000000&aid=0000&mid=0000&msisdn=xxxxxxxx&partner=partnername&userId=xxxx&request_id=xxxxx&otp=xxxxx

Example API Response

Success
{     
  "status": "200",     
  "response": "otp_verified" 
} 

Failure
{     
  "status": "400",     
  "error": "invalid_user_credentials" 
}

For secure interactions, always call the API from the server-side.

Last updated

Was this helpful?