Mobile to Address Lookup

Header Parameters

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code is "1" (Fixed)MY
X-Ipay-Client-IdStringUnique Client Id Provided by InstantpayMY
X-Ipay-Client-SecretStringUnique Client Secret Provided by InstantpayMY
X-Ipay-Endpoint-IpStringEnd customer IP AddressMY

Request Parameters

Parameter Name

Type

Requirement

Description

mobileNumber

String

Mandatory

Mobile Number

latitude

String

Mandatory

End Customer Latitude.

longitude

String

Mandatory

End Customer Longitude

externalRef

String

Mandatory

Your Unique Transaction id

consent

String

Mandatory

Consent should be accepted by customer

Sample Request

curl --location 'https://api.instantpay.in/identity/mobile/addressLookup' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: 14.142.186.142' \
--header 'Content-Type: application/json' \
--data '{
"mobileNumber": "xxxxxxxxxx",
"consent": "Y",
"externalRef": "1758870994",
"latitude": 0.99,
"longitude": 38
}'
POST /identity/mobile/addressLookup HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: 14.142.186.142
Content-Type: application/json
Content-Length: 120

{
    "mobileNumber":"XXXXXXX78",
    "consent":"Y",
    "latitude":0.99,
    "longitude":38,
    "externalRef":"jdnjdi89"
}

Response Parameters

Parameter NameTypeDescription
statuscodeStringInstantpay Status Code
actcodeStringAction Code
statusArrayStatus message
dataStringResponse Data(if Present)
timestampStringResponse time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id(if transaction otherwise it is null)
environmentStringLive/Sandbox
internalCodeStringIt will be null

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "addressData": [
            {
                "name": "Sample Name",
                "address": "sample house number, locality",
                "city": "Noida",
                "state": "UP",
                "country": "India",
                "pin": 201301
            }
        ],
        "poolReferenceId": "1251023150802ACMEK",
        "pool": {
            "openingBal": "11.07",
            "mode": "DR",
            "amount": "3.54",
            "closingBal": "7.53"
        }
    },
    "timestamp": "2025-10-23 15:08:02",
    "ipay_uuid": "h000a02e6b22-b8c8-4c82-b1fe-09b4bc801b0d-Tvu6HfO3vux5",
    "orderid": "1251023150802ACMEK",
    "environment": "LIVE",
    "internalCode": null
}
📘

Consent Text :

I hereby give my consent and submit voluntarily at my own discretion, my Voter ID for the purpose of establishing my identity on the portal. The Voter ID submitted herewith shall not be used for any purpose other than mentioned, or as per the requirements of the law.

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