PIN/OTP Subscription API with multi-advertiser lead routing. Fast, reliable, and built for scale.
All API requests require an API key sent via the X-API-Key header.
Contact us to get your API key provisioned.
| Field | Required | Type | Description |
|---|---|---|---|
| msisdn | Yes | string | Customer mobile number (e.g. 964xxxxxxxx) |
| pixel | Yes | string | Your pixel / click ID |
| cycle | Yes | string | Billing cycle — use daily |
{
"code": 200,
"status": "OK",
"data": "succes request otp"
}
{
"code": 400,
"status": "Bad Request",
"data": "invalid msisdn"
}
| Field | Required | Type | Description |
|---|---|---|---|
| msisdn | Yes | string | Customer mobile number (e.g. 964xxxxxxxx) |
| pin | Yes | string | The PIN/OTP the user received via SMS |
| pixel | Yes | string | Your pixel / click ID |
| cycle | Yes | string | Billing cycle — use daily |
{
"code": 200,
"status": "OK",
"data": "success verify otp"
}
{
"code": 400,
"status": "Bad Request",
"data": "The pin is not valid."
}
| Error Message | Description |
|---|---|
invalid operator | The mobile number's operator is not supported |
invalid service | The service/cycle is not valid |
invalid msisdn | The mobile number format is incorrect |
msisdn already active | The user is already subscribed |
msisdn already inactive | The user is already unsubscribed |
msisdn not found | The mobile number was not found |
The pin is not valid. | The OTP entered is wrong |
The pin has expired. | The OTP has expired, request a new one |
PIN request needed | Must call PIN Send before PIN Verify |
MSISDN Blacklisted. | The mobile number is blacklisted |