post https://api.instantpay.in/identity/okyc/sendOtp
Headers
| Name | Type | Description | Mandatory (M) , Optional (O) | Provided by INSTANTPAY (Y/N) |
|---|---|---|---|---|
| X-Ipay-Auth-Code | String | Auth Code - 1 (Fixed) | M | Y |
| X-Ipay-Client-Id | String | Unique Client ID | M | Y |
| X-Ipay-Client-Secret | String | Unique secret key | M | Y |
| X-Ipay-Endpoint-Ip | String | Customer End Point Ip 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 |
| consent | Enum (Y/N) | Mandatory | Consent should be accepted by customer |
Sample Request
curl --location 'https://api.instantpay.in/identity/okyc/sendOtp' \
--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+sakZg7RsrtyghjkyihgttopephR3cM44TIM92o=",
"latitude" : -21.2273,
"longitude" : -153.5984,
"consent" : "Y"
}'
POST /identity/okyc/sendOtp 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: 152
{
"aadhaarNumber" : "Nt8WtsZg84oity5uuyyyfj5ucTephR3cM44TIM92o=",
"latitude" : -76.2614,
"longitude" : 96.9252,
"consent" : "Y"
}
Response Parameters
| Name | Type | Description |
|---|---|---|
| statuscode | String | Instantpay Status Code |
| actcode | String | Action code |
| status | String | Staus Message |
| 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": "OtpGenerated",
"status": "OTP sent to registered mobile number",
"data": {
"otpReferenceID": "ZGNjMTJkNjItZTI0ZS00YzYyLWE2YzUtY2UzMjdlZDg3MTgy",
"aadhaarNumber": "xxxxxxxx6077"
},
"timestamp": "2023-05-26 10:06:31",
"ipay_uuid": "h0059941ba55-9c81-4f4d-a068-4f9b0a44beff",
"orderid": null,
"environment": "LIVE",
"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.