This API is used to submit the Aadhaar details in an XML file. The access token is required on the header. For more information on getting the access token, refer to Get Token API.
Steps to get Aadhar XML
- Navigate to the following URL for My Aadhaar website:
- Enter the child merchant Aadhaar number or VID and Security Code mentioned in the screen.
- Click Send OTP.
- Enter the OTP received by registered mobile number for the given Aadhaar Number.
- Click Login.
- Click the Offline Ekyc Option & enter a share code which will be the password for the ZIP file and click on the Download button.
- The Zip file containing the digitally signed XML will be downloaded.
Authentication
The access token with the scope as refer_merchant from is required on the header. For more information on getting the access token, refer to Get Token API.
Endpoints
Environment
Test Environment | https://uat-partner.payu.in/api/v3/merchants |
Production Environment | https://partner.payu.in/api/v3/merchants |
Request parameters
Parameter | Description |
---|---|
aadhaar_file
|
|
aadhaar_share_code
|
|
merchant_id
|
|
Sample request
curl -X POST \
'https://api.example.com/v3/merchants/kyc_document/aadhaar_xml_offline' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'Content-Type: multipart/form-data' \
-F 'merchant_id=123456789' \
-F 'aadhaar_share_code=1234-5678-9012' \
-F 'aadhaar_file=@/path/to/your/aadhaar_file.xml'
Sample response
{
"name": "Sardar Khan",
"gender": "M",
"dob": "1996-02-14",
"address": " rz-276,ph-2, gopal nagar, NAJAFGARH, South West Delhi, Delhi, India, 110043",
"pincode": 110043
}