Aadhaar Offline e-KYC Verify OTP
Aadhaar Verification is an important step in KYC. Businesses can automate Aadhaar verification using Sandbox API.
Overview
Verify the Aadhaar number by entering the OTP
and ref_id
received from Aadhaar OKYC Generate OTP API and receive the information pertaining to the individual.
Problem
- After generating the OTP, the business will have to verify the OTP to get Aadhaar details for KYC purposes.
- Companies have to ensure the correct individual is being onboarded.
Solution
- NBFCs, banks, lending platforms, insurance companies, and even HRMS platforms can use these Aadhaar details for verifying the customer.
- The process of verifying Aadhaar with consent is facilitated through the use of OTP.
Endpoint
HTTP Method | Resource |
---|---|
POST | /kyc/aadhaar/okyc/otp/verify |
Request
Follow the below guidelines to pass Aadhaar, consent & reason for verification
Body Parameters
Param | Type | Description | Example |
---|---|---|---|
ref_id | string | Reference ID received from Aadhaar OKYC Generate OTP API | 1234567 |
otp | string | One Time Password received on registered phone number | 999999 |
Sample CURL Request
curl --request POST \
--url https://api.sandbox.co.in/kyc/aadhaar/okyc/otp/verify \
--header 'Authorization: xxxxxxxxxx' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: xxxxxxxxxx' \
--header 'x-api-version: 1.0' \
--data '
{
"otp": "999999",
"ref_id": "1234567"
}
'
Response
The response includes non-identifying public data as below
Param | Type | Description | Example |
---|---|---|---|
ref_id | string | The reference ID you have received in the Aadhaar generate OTP API | 1234567 |
status | string | Aadhaar Exists or not possible values are:VALID INVALID | VALID |
message | string | Message for the status of API | Aadhaar Card Exists |
care_of | string | Relationship details of the Aadhaar Holder. | S/O: Johnny Doe |
dob | string | Date of Birth of the Aadhaar Holder | 123456789012 |
string | Hashed email of Aadhaar Holder | 044917e2c4c62a439d068.......d9f71bbde10b | |
gender | string | Gender of the Aadhaar Holder | M |
name | string | Name of the Aadhaar Holder | John Doe |
split_address | object | Split Address of the Aadhaar Holder | Look Below |
year_of_birth | string | Year of Birth of Aadhaar Holder | 1985 |
mobile_hash | string | Hashed Mobile Number of Aadhaar Holder | 044917e2c4c62a439d068.......d9f71bbde10b1d227a914e |
photo_link | string | Hashed Photo Link of Aadhaar Holder | data:image/jpeg;base64,/9j/4AAQSk.......mj/2Q== |
split_address entity
Param | Type | Description | Example |
---|---|---|---|
country | string | Country of the Aadhaar Holder | India |
dist | string | District of the Aadhaar Holder | Bengaluru |
house | string | House address | Mangal Kanaka Niwas |
landmark | string | Landmark address | - |
pincode | string | Pincode of the Aadhaar Holder | 581615 |
po | string | Post office | Bengaluru |
state | string | State of the Aadhaar Holder | Karnataka |
street | string | Street address | Main Cross 3rd |
subdist | string | Sub District | - |
vtc | string | Village, Town, City(VTC) | Bengaluru |
Response Caching
Response caching is not available for this API. Learn more about our response caching mechanism here
Wallet Charges
Since Aadhaar Offline e-KYC Verify OTP API is a Paid API, a wallet charge will take place.
Versioning
This API is currently in major version 1.0. Refer to our versioning policies here
Updated 9 days ago