ZingHR Dedupe API
API Description & Objectives :
Check duplication for following fields with ZingHR :
- Mobile Number
- Email ID
- PAN
- Bank Account Number (Combination of Account No & IFSC Code)
API Details :
| Particulars | Description |
| API Name | CheckDeDupe API |
| Method | POST |
| URL | UAT : https://clientuat.zinghr.com/2015/Route/EmployeeDetails/CheckDedupe |
| Input Format | JSON |
| Output Format | JSON |
Input: The following input fields are required to Push Employees to ZingHR
Proprty Type (Case Sensitive) | Data Type | Description | Mandatory | Remarks |
| SubscriptionName | String | Subscription name of the account | Yes | Max length 10 characters |
| Token | String | Security check to verify the account and request. | Yes | Token can be generated from Setup Circle -> Portal Setup -> Token Generation |
| ValidationType | String | Validation Type to Check. You can check only one validation type at a time. | Yes | ValidationType Values :
|
Elements of Mobile No. Check :
| MobileNo | String | Mobile No. To Check | Yes | 10 Digit (Without Country code i.e. 0 or +91) |
Elements of Email ID Check :
| EmailId | String | Email Id to check | Yes |
Elements for PAN Check:
| PanNo | String | PAN No to check | Yes |
Elements for Bank Account Check:
Note : Bank Account check will be done on account no. & IFSC Code combination
| AccountNo | String | Account No. To check | Yes | |
| IFSCCode | String | IFSC Code to check | Yes |
API Response Code & Messages :
| Code | Message | Remarks |
| 1 | Success | Successful API call |
| 2 |
| Given messages will be returned on the basis for Validation Type for incorrect input formats |
| 3 |
|
|
| 4 | Internal Server Error | The API execution faced an unexpected error |
| 5 | Token expired | The token is expired and needs to be generated again. Token can be generated from the Setup Circle in ZingHR portal |
API Response on Success:
| Code | 1 |
| Message | Success | |
| ValidationType | Mobile/Pan/Email/Bank_Account | Returns Validation type passed in Input |
| MobileNo | 8097123456 | Mobile number passed in input incase validation type Mobile |
| EmailId | dedupe@email.com | Email passed in input incase of mobile validation type Email |
| PanNo | DEDUP1234E | PAN No passed in input incase of validation type PAN |
| AccountNo IFSCCode | AccountNo & IFSCCode passed in input incase validation type Bank_Account | |
| Status | Valid/Invalid | Valid - If record does not exist in ZingHR Invalid - If record exists in ZingHR |
| EmployeeCode | If status is invalid then returns employee code to whom record is mapped |
API Example :
URL :
UAT : https://clientuat.zinghr.com/2015/Route/EmployeeDetails/CheckDedupe
Production : https://portalzinghr.com/2015/Route/EmployeeDetails/CheckDedupe
1. Mobile No. Check :
Request :
{
"SubscriptionName": "<<Your Account Name>>",
"Token": "<<Your API Token>>",
"ValidationType" : "mobile",
"MobileNo" : "8097123456"
}
Response :
{
"Code": 1,
"Message": "Success",
"ValidationType": "Mobile",
"MobileNo": "8097123456,
"Status": "Valid"
}
2. Email ID Check :
Request :
{
"SubscriptionName": "<<Your Account Name>>",
"Token": "<<Your API Token>>",
"ValidationType" : "Email",
"EmailId" : "TestDedupe@gmail.com"
}
Response :
{
"Code": 1,
"Message": "Success",
"ValidationType": "Email",
"EmailId": "TestDedupe@gmail.com",
"Status": "Valid"
}
3. PAN No Check:
Request :
{
"SubscriptionName": "<<Your Account Name>>",
"Token": "<<Your API Token>>",
"ValidationType" : "Pan",
"PanNo" : "DEDUP1234E"
}
Response :
{
"Code": 1,
"Message": "Success", "ValidationType": "PAN", "PanNo": "DEDUP1234E",
"Status": "Valid"
}
4. Bank Account Check :
Request :
{
"SubscriptionName": "<<Your Account Name>>",
"Token": "<<Your API Token>>",
"ValidationType" : "bank_account",
"AccountNo" : "1234",
"IFSCCode" : "UTIB0000219"
}
Response :
{
"Code": 1,
"Message": "Success", "ValidationType": "Bank_Account", "AccountNo": "1234",
"IFSCCode": "UTIB0000219",
"Status": "Valid"
}
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article