SAP Knowledge Base Article - Public

3398250 - createOnboardeeAPI with national ID as rehireCheck is not working


Check If the Onboardee Is a Rehire through createOnboardee API like below

{"userId":"XXX","email":"","userName":"XXX","password":"XXX","applicationId":"XXX","rehireCheckParams": { "nationalIdDetails": {            "CHN": "1234011XXX75"        }

There is a terminated user with national id "1234011XXX75".

However, onboardee is created.

Rehire user is not returned


SAP SuccessFactors Onboarding


  1. Identifier used in API is incorrect.
  2. Lack of permission.


1. Identifier of nationalIdDetails used in API must match the one in Manage Business Configuration.

Case sensitive.

For China it should be like:


{ "ResidentIdCard ": "123501XXXX013898 " }

For USA it should be like:


{ "ssn": "888-XX-8810" }

2. Make sure the API user has both Rehire Inactive Employee with New Employment (by ‘match’ in New Hire) and Rehire Inactive Employee (by ‘match’ in New Hire) permissions


KBA , LOD-SF-OBX-ATS , ATS Integration , Problem


SAP SuccessFactors Onboarding all versions