post https://api.instantpay.in/identity/mobile/nameLookup
A Name Lookup API that allows users or applications to look up the owner’s name associated with a given phone number. These APIs are used in cases where you need to verify the identity of a caller, enhance user profiles, or validate the legitimacy of phone numbers.
Header Parameters
| 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 Provided by Instantpay | M | Y |
| X-Ipay-Client-Secret | String | Unique Client Secret Provided by Instantpay | M | Y |
| X-Ipay-Endpoint-Ip | String | End customer IP Address | M | Y |
Request Parameters
| Parameter Name | Type | Requirement | Description |
|---|---|---|---|
| mobileNumber | String | Mandatory | User 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/nameLookup' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: YWY3Oxxxxxxxxxx5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 82e4755xxxxxxxxxxxxxx7f3000aa5b56fc926d1' \
--header 'X-Ipay-Endpoint-Ip: 14.142.186.142' \
--header 'Content-Type: application/json' \
--data '{
"mobileNumber" : 9876543210,
"consent" : "Y",
"latitude": "11.1009",
"longitude": "26.9119",
"externalRef": "1729743447"
}'
POST /identity/mobile/nameLookup HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzxxxxxxxxxxxxcETrD5Yx+Q=
X-Ipay-Client-Secret: 82e4755d7xxxxxxxxxxxxxxxxxxxx87f3000aa5b56fc926d1
X-Ipay-Endpoint-Ip: 14.142.186.142
Content-Type: application/json
Content-Length: 144
{
"mobileNumber" : 9876543210,
"consent" : "Y",
"latitude": "11.1009",
"longitude": "26.9119",
"externalRef": "1729743474"
}
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| statuscode | String | Instantpay Status Code |
| actcode | String | Action Code |
| status | Array | Status message |
| data | String | Response Data(if Present) |
| timestamp | String | Response time (YYYY-MM-DD HH:II:SS) |
| ipay_uuid | String | Request reference number |
| orderid | String | Transaction Id(if transaction otherwise it is null) |
| environment | String | Live/Sandbox |
| internalCode | String | It will be null |
Sample Response
{
"statuscode": "TXN",
"actcode": null,
"status": "Transaction Successful",
"data": {
"result": {
"mobileLinkedName": "Ravi"
},
"poolReferenceId": "1241023100643TTMGX",
"pool": {
"openingBal": "98921.48",
"mode": "DR",
"amount": "2.36",
"closingBal": "98919.12"
}
},
"timestamp": "2024-10-23 15:36:43",
"ipay_uuid": "h0009d503448-becb-4280-96e9-a97caf1a7e93-QFUQCEKHB3Rv",
"orderid": "1241023100643TTMGX",
"environment": "SANDBOX"
}
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.