Skip to main content

Request OTP

Send request for aadhaar otp.

{{base_url}}/request-otp

Headers:

Content-Type: application/json
app-id: {{appId}}
api-key: {{apiKey}}

Sample Request Body:

{
"aadhaarNumber": "123456781234",
"consent": "Y",
"consentText": "I hear by declare my consent agreement for fetching my Aadhaar information"
}

Attributes in Request Body

AttributeRequiredDescription
aadhaarNumberyes12-digit Aadhaar number of the user.
consentyesuser's consent indicator, typically "Y" for Yes or "N" for No.
consentTextyestext indicating the user’s consent for fetching Aadhaar details.

Send Request

Click Send and wait for the response.

Sample Response Body:

{
"request_id": "9ed1966e-8aa1-4faa-9b23-5dd656390348",
"task_id": "08826ca8-6dc4-47af-8837-747b64371b93",
"group_id": "81ae4378-5ecc-4cd6-9645-1ed2d7d69e8c",
"success": true,
"response_code": "100",
"response_message": "Valid Authentication",
"result": {
"is_otp_sent": true,
"is_number_linked": true,
"is_aadhaar_valid": true
},
"metadata": {
"billable": "N",
"reason_code": "TXN",
"reason_message": "Transaction Successful"
},
"request_timestamp": "2024-05-27T15:58:45.254Z",
"response_timestamp": "2024-05-27T15:58:46.411Z"
}