Title: Generate OTP for a Customer Using the API  
PrimaryCategory: API  
Type: Procedural  
Tags: otp, api, authentication, customerid, token, http  
Source UI Terms: auth-userid, api-key, customerid  
Source Reference: Generate OTP for a Customer Using the API

---

Prerequisites:
- Obtain valid `auth-userid` (integer) and `api-key` (string) for authentication.
- Identify the target customer’s `customerid` (integer).

Steps:
1) Prepare an HTTP GET request to the endpoint:  
   `https://test.httpapi.com/api/customers/authenticate/generate-otp.json`
2) Include the following query parameters in the URL:  
   - `auth-userid` (required): Your authentication user ID (integer).  
   - `api-key` (required): Your API key (string).  
   - `customerid` (required): The customer ID for whom the OTP is to be generated (integer).
3) Send the GET request to the API endpoint.
4) Check the API response:  
   - If the response returns `true` (Boolean), the OTP token has been successfully generated.  
   - If there is an error, a JSON object with a `status` key set to `ERROR` and an accompanying error message will be returned.

Warnings:
- Ensure all required parameters are provided; missing parameters result in an error response.  
- Keep your `api-key` secure to prevent unauthorized use.

Summary:
To generate a one-time password for a customer, send a GET request to the API with the required authentication parameters and customer ID, then confirm success by checking for a true Boolean response.

Evaluation Pairs:
Q1: What parameters are required to generate an OTP for a customer using the API?  
A1: The required parameters are `auth-userid` (integer), `api-key` (string), and `customerid` (integer).

Q2: What HTTP method is used to generate the OTP token?  
A2: The HTTP method used is GET.

Q3: How can I tell if the OTP generation was successful from the API response?  
A3: The response returns `true` (Boolean) if the OTP token is generated; otherwise, it returns a status key with value `ERROR` and an error message.

<p>When you want to generate a one-time password for a customer using the API. This article explains the required authentication parameters, customer ID input, OTP generation request, and API response behavior.</p>
<div class="region region-content">
<div class="hidden"> </div>
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<h1 class="title page-title"><span class="field field--name-title field--type-string field--label-hidden">Generate OTP</span></h1>
<div id="toc" style="display: block;">
<div id="toc_content">
<p> </p>
</div>
</div>
</div>
</div>
<div class="node__content clearfix">
<div class="layout layout--onecol">
<div class="layout__region layout__region--content">
<div class="clearfix text-formatted field field--name-body field--type-text-with-summary field--label-hidden field__item">
<h2>Description</h2>
<p>Generates an OTP token for the customer.</p>
<h2>Parameters</h2>
<table class="codetable"><tbody><tr><th colspan="1" rowspan="1">Name</th><th colspan="1" rowspan="1">Data Type</th><th colspan="1" rowspan="1">Required / Optional</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">auth-userid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">api-key</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">customerid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Customer ID of the Customer</td></tr></tbody></table>
<h2>HTTP Method</h2>
<p>GET</p>
<h2>Example Test URL Request</h2>
<p><code>https://test.httpapi.com/api/customers/authenticate/generate-otp.json?auth-userid=0&amp;api-key=key&amp;customerid=0 </code></p>
<h2>Response</h2>
<p>Returns <em>true</em> (<a href="/help/article/answer/755#bool" target="_blank">Boolean</a>), if the OTP token is generated.</p>
<p>In case of any errors, a <strong>status</strong> key with value as <em>ERROR</em> alongwith an error message will be returned.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to generate a one-time password for a customer using the API. This article explains the required authentication parameters, customer ID input, OTP generation request, and API response behavior.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
customerid	Integer	Required	Customer ID of the Customer