Use Case Description
This use case is for completing an existing applicant onboarding process.The endpoint takes applicantID, returned in the response for the initiate onboarding request, as a parameter in the URL to identify the applicant.Payload isn't required for this endpoint unlike the other endpoints in this documentation. The response consists of either success or failure message.
Currently the Applicant Onboard V2 API is not supported to complete the onboarding process. This is documented in Chapter 6 - Known Issues and Limitations under DE701803: Onboarding.complete API failed with 400 Bad Request error where information is partially saved for the employee, contractor and company.
API Usage
|
Method |
URI |
Description |
GitHub Sample Request Payload |
GitHub Sample Response Payload |
|---|---|---|---|---|
| POST | hcm/v2/applicants/{applicantid}/onboarding.complete | Complete the applicant onboarding process. | NA |
Complete_Success_Response.json |
Application Scope
The following canonical needs to be added to your application scope to enable this use case:
/hcm/integrationManagement/applicantOnboardingManagement/onboardingProcessManagement/
applicantOnboarding.complete
Request Header Parameters
There are no request header parameters.
Supported Actors
|
Request Parameter roleCode Value |
Usage |
|---|---|
| Practitioner | Completes the onboarding of an existing applicant. A system user is considered a practitioner. |
Sequence of Interactions
Complete After Post
Complete After Update
Responses
You may encounter exceptions outside your common success scenarios. You must account for these exceptions during your initial development.
For more information, see API Common Exceptions and Tips for Handling.
|
Response Code |
Condition |
Message Txt |
GitHub Sample Request Payload |
GitHub Sample Response Payload |
|---|---|---|---|---|
| 400 Bad Request | When Middle Initial in the Onboard or Update request payload has more than one character. | The Middle Initial field can include only one letter (A-Z). [<given middle initial>] |
NA |
|
| 400 Bad Request | When there is some failure in completing the request. | 41415 -Save partially successful, please resolve and complete the setup in the payroll application. | NA | |
| 400 Bad Request | When applicantID given the request URI is not in valid GUID format. | Guide should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). | NA | |
| 400 Bad Request | When the given applicantID doesn't exist. | 41414 -Applicant with the requested applicantID does not exist. | NA | InvalidApplicantID_400_Res.json |
AOID of an Applicant
When all three APIs (Initiating, Updating, and completing Of Onboarding Process) are successfully completed, the employee is completely hired and active in RUN Powered by ADP. We can only retrieve the AOID of the employee in the workers call after the employee is completely hired.
