Title: Verify a Sub-Reseller OTP Using the API
PrimaryCategory: API
Type: Procedural
Tags: sub-reseller, otp, api, authentication, sms, google_authenticator, verification
Source UI Terms: auth-userid, api-key, resellerid, otp, type
Source Reference: Verify a Sub-Reseller OTP Using the API

Prerequisites:
- Have the Sub-Reseller&#39;s reseller ID.
- Obtain authentication credentials: auth-userid and api-key.
- Have the OTP sent to the Sub-Reseller.

Steps:
1) Make a GET request to the endpoint:
   `https://test.httpapi.com/api/resellers/authenticate/verify-otp.json`
2) Include the following parameters in the query string:
   - `auth-userid`: Your authentication user ID (integer).
   - `api-key`: Your API key (string).
   - `resellerid`: The Sub-Reseller&#39;s reseller ID (integer).
   - `otp`: The One-Time Password sent to the Sub-Reseller (string).
   - `type` (optional): Type of authentication (`sms`, `gauth`, or `gauthbackup`).
     Note: If omitted, defaults to `sms`.
3) Send the request.
4) Interpret the response:
   - If authentication is successful, the response returns `true` (Boolean).
   - If there is an error, the response contains a `status` key with value `ERROR` and an error message.

Summary:
To verify a Sub-Reseller&#39;s OTP using the API, send a GET request with required authentication and OTP parameters to the verification endpoint. The API returns true if the OTP is valid or an error message if verification fails.

Evaluation Pairs:
Q: What parameters are required to verify a Sub-Reseller OTP using the API?
A: The required parameters are `auth-userid`, `api-key`, `resellerid`, and the `otp`.

Q: What happens if the `type` parameter is not included in the OTP verification request?
A: The type defaults to `sms` for authentication if the `type` parameter is not provided.

Q: How does the API indicate a failed OTP verification?
A: It returns a response with a `status` key set to `ERROR` and an accompanying error message.

<p>When you want to authenticate a Sub-Reseller OTP using the API. This article explains supported OTP verification types, required parameters, and response details for SMS and Google Authenticator-based authentication.</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">Verify 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><a name="heading_0"></a>Description</h2>
<p>Authenticates the Sub-Reseller OTP token.</p>
<h2><a name="heading_1"></a>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">resellerid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Reseller ID of the Sub-Reseller</td></tr><tr><td colspan="1" rowspan="1">otp</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">OTP sent to the Sub-Reseller</td></tr><tr><td colspan="1" rowspan="1">type</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">The type of authentication
<ul><li>Sms</li><li>gauth</li><li>gauthbackup</li></ul>
<p>If no value is passed type=sms by default.</p>
</td></tr></tbody></table>
<h2><a name="heading_2"></a>HTTP Method</h2>
<p>GET</p>
<h2><a name="heading_3"></a>Example Test URL Request</h2>
<p><code>https://test.httpapi.com/api/resellers/authenticate/verify-otp.json?auth-userid=0&amp;api-key=key&amp;resellerid=0&amp;otp=987654&amp;type=gauth</code></p>
<h2><a name="heading_4"></a>Response</h2>
<p>Returns <em>true</em> (Boolean), if the OTP token is authenticated.</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 authenticate a Sub-Reseller OTP using the API. This article explains supported OTP verification types, required parameters, and response details for SMS and Google Authenticator-based authentication.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
resellerid	Integer	Required	Reseller ID of the Sub-Reseller
otp	String	Required	OTP sent to the Sub-Reseller
type	String	Optional	The type of authentication Sms gauth gauthbackup If no value is passed type=sms by default.