Send OTP


NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code - 1 (Fixed)MY
X-Ipay-Client-IdStringUnique Client IDMY
X-Ipay-Client-SecretStringUnique secret keyMY
X-Ipay-Endpoint-IpStringCustomer End Point Ip AddressMN

Request Parameters

aadhaarNumberStringMandatoryAadhaar Number in aes-256-cbc Encryption
latitudeStringMandatoryEnd Customer Latitude
longitudeStringMandatoryEnd Customer longitude
consentEnum (Y/N)MandatoryConsent should be
accepted by

Sample Request

curl --location '' \
--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
Accept: application/json
Content-Type: application/json
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825
Content-Length: 152

    "aadhaarNumber" : "Nt8WtsZg84oity5uuyyyfj5ucTephR3cM44TIM92o=",
    "latitude" : -76.2614,
    "longitude" : 96.9252,
    "consent" : "Y"

Response Parameters

statuscodeStringInstantpay Status Code
actcodeStringAction code
statusStringStaus Message
dataArrayResponse Data (If Present)
timestampStringResponse time (YYYY-MM-DD HH:MM:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )

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.

Click Try It! to start a request and see the response here!