post https://api.instantpay.in/identity/corporateEmpCheck
The Mobile to UAN Lookup API is a robust tool designed to empower employees to access their Universal Account Number (UAN) using their mobile numbers. The UAN serves as a unique identification number assigned to every member of the Employees' Provident Fund Organization (EPFO) in India. With this API, employees can effortlessly and securely retrieve their UAN and related information, enhancing convenience and accessibility.
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 |
---|---|---|---|
customerPhoneNumber | 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/corporateEmpCheck' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'Content-Type: application/json' \
--data '{
"customerPhoneNumber":"7428585742",
"consent":"Y",
"latitude":0.99,
"longitude":38,
"externalRef":"jdnjdi89"
}'
POST /identity/corporateEmpCheck HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825
X-Ipay-Endpoint-Ip: 14.142.186.142
Content-Type: application/json
Content-Length: 116
{
"customerPhoneNumber":"7428585742",
"consent":"Y",
"latitude":0.99,
"longitude":38,
"externalRef":"jdnjdi89"
}
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": {
"employeData": {
"personalDetails": {
"userGender": "MALE",
"userDob": "08/09/1998",
"userFullName": "Sample Name",
"userPhoneNumber": "7428585742"
},
"employmentDetails": {
"isEmployed": true,
"dateOfExitMarked": false,
"uanList": [
"101748344546"
],
"uanCount": 1,
"recentEmployerData": {
"memberId": "DSNHP13800300000332",
"establishmentId": "DSNHP13800000",
"dateOfExit": "NA",
"dateOfJoining": "18/10/2021",
"establishmentName": "INSTANTPAY INDIA LIMITED",
"uanNumber": "1017123444546"
},
"previousEmployerData": {
"list": [
{
"sequenceNumber": "1",
"uanNumber": "101748344546",
"dateOfExit": "NA",
"dateOfJoining": "18/10/2021",
"establishmentId": "DSNHP13800120000",
"establishmentName": "INSTANTPAY INDIA LIMITED",
"memberId": "DSNHP13800301000332",
"leaveReason": "NA",
"mobile": "NA",
"aadhaarVerificationStatus": "Verified"
}
]
}
}
},
"pool": {
"referenceId": "1240130150440BSGHU",
"openingBalance": "20.97",
"paymentAmount": "5.90",
"mode": "DR",
"closingBalance": "15.07"
}
},
"timestamp": "2024-01-30 15:04:40",
"ipay_uuid": "h0059b370c0f-3176-417f-b799-518c8638edbc-D2ldwjni01D9",
"orderid": "1240130150440BSGHU",
"environment": "LIVE",
"internalCode": null
}