> For the complete documentation index, see [llms.txt](https://knowledgebase.offer18.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.offer18.com/affiliate/affiliate-apis/otp-api.md).

# OTP API

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

### **Common Parameters**

<table data-header-hidden><thead><tr><th width="150">Path</th><th width="150"> </th><th> </th></tr></thead><tbody><tr><td><strong>Query</strong></td><td><strong>Type</strong></td><td><strong>Description</strong></td></tr><tr><td>key</td><td>String</td><td>API Key</td></tr><tr><td>aid</td><td>Integer</td><td>Affiliate Id</td></tr><tr><td>mid</td><td>Integer</td><td>Your Advertiser MID</td></tr></tbody></table>

## Generate OTP

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

### Request Parameters

<table data-header-hidden><thead><tr><th width="212.5555419921875"></th><th width="191"></th><th></th></tr></thead><tbody><tr><td><strong>Body</strong></td><td><strong>Type</strong></td><td><strong>Description</strong>  </td></tr><tr><td>type</td><td>string</td><td>Type of request</td></tr><tr><td>userId</td><td>string</td><td>User ID (under Partner)</td></tr><tr><td>msisdn</td><td>string</td><td>Mobile number (numeric)</td></tr><tr><td>partner</td><td>string</td><td>Partner name</td></tr></tbody></table>

<pre data-overflow="wrap"><code><strong>https://api.offer18.com/api/af/otp_gen?key=000000000&#x26;aid=0000&#x26;mid=0000&#x26;msisdn=xxxxxxxx&#x26;partner=partnername&#x26;userId=xxxx
</strong></code></pre>

{% code title="Success" overflow="wrap" %}

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

{% endcode %}

{% code title="Failure" overflow="wrap" %}

```json
{     
  "status": "400",     
  "error": "invalid_user_credentials" 
}
```

{% endcode %}

***

## Verify OTP

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

### Request Parameters

<table data-header-hidden><thead><tr><th width="212.5555419921875"></th><th width="191"></th><th></th></tr></thead><tbody><tr><td><strong>Body</strong></td><td><strong>Type</strong></td><td><strong>Description</strong>  </td></tr><tr><td>userId</td><td>string</td><td>User ID</td></tr><tr><td>msisdn</td><td>string</td><td>Mobile number</td></tr><tr><td>otp</td><td>string</td><td>OTP received by the user</td></tr><tr><td>partner</td><td>string</td><td>Partner name</td></tr><tr><td>request_id</td><td>string</td><td>Request ID for tracking</td></tr></tbody></table>

{% code overflow="wrap" %}

```
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
```

{% endcode %}

### Example API Response

{% code title="Success" overflow="wrap" %}

```json
{     
  "status": "200",     
  "response": "otp_verified" 
} 
```

{% endcode %}

{% code title="Failure" overflow="wrap" %}

```json
{     
  "status": "400",     
  "error": "invalid_user_credentials" 
}
```

{% endcode %}

***

{% hint style="info" %}
**For secure interactions, always call the API from the server-side.**
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://knowledgebase.offer18.com/affiliate/affiliate-apis/otp-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.