post deprecatedhttps://api.sandbox.co.in/kyc/aadhaar/okyc/otp/verify
Verify the Aadhaar number by passing the OTP received on the individual's registered mobile number.
This API is deprecated and may shut down anytime. Use the upcoming DigiLocker SDK for KYC with multiple documents, including Aadhaar.
Key | Type | Description | Example |
---|---|---|---|
reference_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 or 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 |
full_address | string | Address of the Aadhaar Holder | Main Cross 3rd, Bengaluru, Karnataka |
email_hash | 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 |
year_of_birth | string | Year of Birth of Aadhaar Holder | 1985 |
mobile_hash | string | Hashed Mobile Number of Aadhaar Holder | 044917e2c4c62a439d068. |
photo | string | Hashed Photo Link of Aadhaar Holder | data:image/jpeg;base64,/9j/4A.. |
share_code | string | Share code | 9999 |
address | object | Split Address of the Aadhaar Holder | View Address Details |
Detailed Address
Key | Type | Description | Example |
---|---|---|---|
country | string | Country of the Aadhaar Holder | India |
district | 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 |
post_office | string | Post office | Bengaluru |
state | string | State of the Aadhaar Holder | Karnataka |
street | string | Street address | Main Cross 3rd |
subdistrict | string | Sub District | - |
vtc | string | Village, Town, City (VTC) | Bengaluru |
Test Environment: https://test-api.sandbox.co.in
Run in Postman | Response | Remarks |
---|---|---|
Test request | 200 | Success |
Test request | 200 | Invalid OTP |
Test request | 200 | OTP Expired |
Test request | 200 | Request under process |
Test request | 200 | Invalid Reference Id |
Test request | 422 | OTP missing in the request |
Test request | 422 | Invalid Reference Id |