Verify OTP API | API Developer Portal

Request Method :: POST

Description: This API validates the OTP sent to the user's Aadhaar-linked mobile number, ensuring secure and consent-based identity verification.

Headers

Content-Type: application/JSON

header_secrets: To be shared during integration by ISU Team

pass_key: To be shared during integration by ISU Team

Request Body Parameters

Parameters	Parameter description with validations and examples	Data type	Mandatory/Optional
aadhaarNo	Aadhaar Number.Must have a length of 12. E.g. - "123456789876"	String	Mandatory
otp	OTP received. E.g. - "04734"	String	Mandatory
requestId	Request ID Number. E.g. - "e055b9c2-98a9-45abb9a1-172b59132fdc"	String	Mandatory

Sample Request Body

{ "aadhaarNo": "123456789876", "otp": "04734", "requestId": "e055b9c2-98a9-45ab-b9a1-172b59132fdc" }

Encrypted Sample Request Body

{ "RequestData": " vYK942PIjdCzQQGOY9polPx7RogzKDqVIycX3Qeddtz8KgMr+4jKVp8yz4dkyZBvUYoQ0lWJMfRIh4QqNpj kL/0y8J2HScJdYULXPwyiRKg=" }

Response Body Parameters (Success)

Parameters	Parameter description with examples	Data type
status	Status Code	String
message	Status Description. E.g. - "OTP sent to registered mobile number"	integer
result	Result of the operation.
generatedDateTime	Generated Date and Time.	String
maskedAadhaarNumber	Aadhaar Number in Masked format.	String
name	Name	String
dob	Date of Birth	string
gender	Gender	string
fatherName	Name of Father.	string
address	Address details.
splitAddress	Address in Split format.
houseNumber	House Number.	string
street	Street Name.	string
landmark	Landmark	string
subdistrict	Name of Sub-district.	string
district	Name of District.	string
vtcName	Name of Village, Town or City	string
location	Location.	string
postOffice	Name of the Post Office	string
state	State Name.	string
country	Country Name.	string
pincode	Address PIN Code.	string
combinedAddress	Address in combined format (reflects the data provided in the split format).	string
maskedVID	Masked VID Number. E.g. - "XXXX XXXX 7691"	string
PADAF	Front Page of the Aadhaar.
docRefId	Document Reference ID.	string
docUrl	Document URL.	string
docName	Name of the Document.	string
password	Password	string
docFormat	Document Format	string
PADAB	Back Page of the Aadhaar.
docRefId	Document Reference ID.	string
docUrl	Document URL.	string
docName	Name of the Document.	string
password	Password	string
docFormat	Document Format	string

Sample Response Body

SUCCESS:

{ "status": 0, "message": "Aadhaar XML file downloaded successfully", "result": { "generatedDateTime": "2024-11-15 10:21:51.022", "maskedAadhaarNumber": "XXXX XXXX 7691", "name": "Biswajit Dash", "dob": "2000-01-24", "gender": "M", "fatherName": "Chandra Sekhar Dash", "address": { "splitAddress": { "houseNumber": "BHINGARAPUR", "street": "BHATAPATANA", "landmark": null, "subdistrict": "Balianta", "district": "Khorda", "vtcName": "Bhingarpur", "location": null, "postOffice": "Bhatpatna", "state": "Odisha", "country": "India", "pincode": "752115" }, "combinedAddress": "BHINGARAPUR, BHATAPATANA, Balianta, Khorda, Bhingarpur, Bhatpatna, Odisha, India, 752115" }, "maskedVID": "XXXX XXXX 7691", "PADAF": [ { "docRefId": "180544643", "docUrl": "https://www.niyogin.com//documents/20152/180465/upload_00135292+(1).pdf/7a17efefc7eb-72c6-538a-f0622291ee70?version=1.0&t=1731646314453", "docName": "aadhaar_1088_e055b9c2-98a9-45ab-b9a1-172b59132fdc_time_1731646311541.pdf", "password": "", "docFormat": "application/pdf" } ], "PADAB": [ { "docRefId": "180544643", "docUrl": "https://www.niyogin.com//documents/20152/180465/upload_00135292+(1).pdf/7a17efefc7eb-72c6-538a-f0622291ee70?version=1.0&t=1731646314453", "docName": "aadhaar_1088_e055b9c2-98a9-45ab-b9a1-172b59132fdc_time_1731646311541.pdf", "password": "", "docFormat": "application/pdf" } ] } }

FAILED:

{ "status": 1, "message": "Something went wrong", "result": {} }

Encrypted Sample Response Body

{ "ResponseData":"EE6V+m0GHnGryRZhcE0XRbqAayBqTPJSX/ lFalXrNsKSIoqaALdLAmrb0cfh3LDKKJlQnazu+rKp6OS9PqEuwpAFtbwtq2DPRy9INcqmiEBh1kzroDVD9 Vc9sN6y" }

Status Codes

Status	Status Code	Description
SUCCESS	0	Aadhaar XML file downloaded successfully
FAILED	1	Something went wrong