ZingHR Dedupe API

Modified on Wed, 26 May 2021 at 03:58 PM


ZingHR Dedupe API 



API Description & Objectives :

Check duplication for following fields with ZingHR :

  1. Mobile Number
  2. Email ID
  3. PAN
  4. Bank Account Number (Combination of Account No & IFSC Code)

 

API Details :

ParticularsDescription
API Name
CheckDeDupe API
MethodPOST
URL

UAT :

https://clientuat.zinghr.com/2015/Route/EmployeeDetails/CheckDedupe 

Production:

https://portal.zinghr.com/2015/Route/EmployeeDetails/CheckDedupe 

Input FormatJSON
Output FormatJSON




Input: The following input fields are required to Push Employees to ZingHR


Proprty Type (Case Sensitive)

Data TypeDescriptionMandatoryRemarks
SubscriptionNameString

Subscription name of the

account
YesMax length 10 characters
TokenString

Security check to verify the account and

request.
YesToken can be generated from Setup Circle -> Portal Setup -> Token Generation
ValidationType
StringValidation Type to Check. You can check only one validation type at a time.Yes

ValidationType Values :

  1. “Mobile”
  2. “Email”
  3. “Pan”
  4. “Bank_Account”


 


Elements of Mobile No. Check :

MobileNoStringMobile No. To CheckYes

10 Digit (Without Country code i.e. 0 or +91)




Elements of Email ID Check :

EmailIdStringEmail Id to checkYes




Elements for PAN Check:

PanNoStringPAN No to checkYes




Elements for Bank Account Check:

Note : Bank Account check will be done on account no. & IFSC Code combination

AccountNoStringAccount No. To checkYes
IFSCCodeString

IFSC Code to check

Yes




API Response Code & Messages :

CodeMessageRemarks
1SuccessSuccessful API call
2
  1. Invalid Format for PAN
  2. Mobile No is Not Valid
  3. Incorrect Email ID
  4. Invalid Format of IFSC Code
Given messages will be returned on the basis for Validation Type for incorrect input formats
3
  1. Invalid Token
  2. Invalid Input Parameters
  1. The token passed in the API did not match the token in the system. Validate the token from the Setup Circle in ZingHR portal
  2. The input parameters passed in API are not correct. (All property names in input parameters are case sensitive)
4Internal Server ErrorThe API execution faced an unexpected error
5Token expiredThe token is expired and needs to be generated again. Token can be generated from the Setup Circle in ZingHR portal




API Response on Success:

Code1



MessageSuccess
ValidationTypeMobile/Pan/Email/Bank_AccountReturns Validation type passed in Input
MobileNo8097123456Mobile number passed in input incase validation type Mobile
EmailIddedupe@email.comEmail passed in input incase of mobile validation type Email
PanNoDEDUP1234EPAN No passed in input incase of validation type PAN
AccountNo 
IFSCCode

AccountNo & IFSCCode passed in input incase validation type Bank_Account
StatusValid/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

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article