post https://api.instantpay.in/identity/verifyAadhaar
Instantpay's Aadhaar Demographic Verification API solution empowers businesses to swiftly and accurately verify an individual's demographic details associated with their Aadhaar number.
Headers
Name | Type | Description | Mandatory (M) , Optional (O) | Provided by INSTANTPAY (Y/N) |
---|---|---|---|---|
X-Ipay-Auth-Code | String | Auth Code is 1 (Fixed) | M | Y |
X-Ipay-Client-Id | String | Unique Client Id | M | Y |
X-Ipay-Client-Secret | String | Unique Client Secret | M | Y |
X-Ipay-Endpoint-Ip | String | Customer End Point Id Address | M | N |
Request Parameters
Name | Type | Requirement | Description |
---|---|---|---|
aadhaarNumber | String | Mandatory | Aadhaar Number in aes-256-cbc Encryption |
latitude | String | Mandatory | End Customer Latitude |
longitude | String | Mandatory | End Customer longitude |
externalRef | String | Mandatory | Unique Transaction Id |
consent | String | Mandatory | It will be Y or N |
Sample Request
curl --location 'https://api.instantpay.in/identity/verifyAadhaar' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
---header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--data '{
"aadhaarNumber": "Nt8WtsZg84L+sakZg7Rstqpj5ucTephR3cM44TIM92o=",
"latitude": "80.123456",
"longitude": "12.234567",
"externalRef": "abc1256",
"consent" : "Y"
}'
POST /identity/verifyAadhaar HTTP/1.1
Host: api.instantpay.in
Accept: application/json
Content-Type: application/json
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825
X-Ipay-Endpoint-Ip: 45.115.105.205
Content-Length: 160
{
"aadhaarNumber": "Nt8WtsZg84L+sakZg7Rstqpj5ucTephR3cM44TIM92o=",
"latitude": "80.123456",
"longitude": "12.234567",
"externalRef": "abc1256",
"consent" : "Y"
}
Response Parameters
Name | Type | Description |
---|---|---|
statuscode | String | InstantPay Status Code |
actcode | String | Action Code |
status | String | Status Code |
data | Array | Response Data (If Present) |
timestamp | String | Response time (YYYY-MM-DD HH:MM:SS) |
ipay_uuid | String | Request reference number |
orderid | String | Transaction Id ( If transaction otherwise it is null ) |
environment | String | Live/Sandbox |
Sample Response
{
"statuscode": "TXN",
"actcode": null,
"status": "Aadhaar Verification Successful",
"data": {
"poolReferenceId": "1230717111733NHBJQ",
"pool": {
"openingBal": "96180.83",
"amount": "3.54",
"closingBal": "96177.29"
},
"optional1Label": "Address",
"optional1": "Uttar Pradesh",
"optional2Label": "Age Band",
"optional2": "20-30",
"optional3Label": "Gender",
"optional3": "M",
"optional4Label": "Mobile Number",
"optional4": "*******547"
},
"timestamp": "2023-07-17 11:17:33",
"ipay_uuid": "h00099aa6ef7-75e2-496c-b256-2a775fea2156",
"orderid": "1230717111733NHBJQ",
"environment": "SANDBOX",
"internalCode": null
}
Consent Text :
I hereby give my consent and submit voluntarily at my own discretion, my Aadhaar Number or VID for the
purpose of establishing my identity on the portal. The Aadhaar submitted herewith shall not be used for
any purpose other than mentioned, or as per the requirements of the law.