Title: Verify a Customer OTP Using the API  
PrimaryCategory: API  
Type: Procedural  
Tags: otp, authentication, api, customers, sms, google_authenticator  
Source UI Terms: auth-userid, api-key, customerid, otp, type  
Source Reference: Verify a Customer OTP Using the API  

Prerequisites:
- Have your API authentication credentials: auth-userid and api-key.
- Know the customerid for the customer whose OTP you want to verify.
- Have the OTP token sent to the customer.

Steps:
1) Construct a POST request to the Verify OTP API endpoint:  
   `https://test.httpapi.com/api/customers/authenticate/verify-otp.json`
2) Include the following parameters in the request query or body:  
   - `auth-userid` (Integer, Required): Your API user ID.  
   - `api-key` (String, Required): Your API key.  
   - `customerid` (Integer, Required): The target customer&#39;s ID.  
   - `otp` (String, Required): The OTP received by the customer.  
   - `type` (String, Optional): The type of OTP authentication. Valid values:  
     - `sms` (default if omitted)  
     - `gauth` (Google Authenticator)  
     - `gauthbackup` (Google Authenticator backup)  
3) Send the POST request to verify the OTP.
4) Check the response:  
   - If successful, the API returns a Boolean value `true`.  
   - In case of error, the response contains a `&quot;status&quot;` key with the value `&quot;ERROR&quot;` and an error message.

Warnings:
- Omitting the `type` parameter defaults the OTP verification to SMS type.
- Ensure all required parameters are included; missing any will cause an error response.

Summary:
You can verify a customer&#39;s OTP by sending a POST request with required credentials and OTP details to the API, which responds with true if verification succeeds or an error message if it fails.

Evaluation Pairs:
Q: What parameters are required to verify a customer OTP using the API?  
A: You must provide `auth-userid`, `api-key`, `customerid`, and `otp`. The `type` parameter is optional.

Q: What happens if the `type` parameter is omitted when verifying OTP?  
A: The OTP verification defaults to type `sms`.

Q: How can you tell if the OTP verification succeeded or failed?  
A: The API returns `true` if the OTP is authenticated, or a JSON error response with a status of `ERROR` and an error message if it fails.

<p>When you want to authenticate a customer OTP using the API. This article explains supported OTP verification types, required parameters, and response details for SMS and Google Authenticator-based customer authentication.<br><br></p>
<div class="region region-content">
<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"></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 Customer 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">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><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 Customer</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>POST</p>
<h2><a name="heading_3"></a>Example Test URL Request</h2>
<p><code>https://test.httpapi.com/api/customers/authenticate/verify-otp.json?auth-userid=0&amp;api-key=key&amp;customerid=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 customer OTP using the API. This article explains supported OTP verification types, required parameters, and response details for SMS and Google Authenticator-based customer authentication.

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
otp	String	Required	OTP sent to the Customer
type	String	Optional	The type of authentication Sms gauth gauthbackup If no value is passed type=sms by default.