Start Self-Onboarding

Employee self-onboarding begins with the company's admin, who selects and modifies the template with which the company wants to onboard the new employee. The company's admin can call the required endpoints in this phase for successful employee onboarding.

Onboarding starts with the employer

This phase is the beginning of the employee self-onboarding, managed and controlled by the Company's Admin. The Company's Admin calls the following endpoints in this phase:

Start new employee onboarding endpoint

This makes a POST request that returns an onboarding ID for the new employee onboarding and the current step that the Company's Admin is in during the phase 1 onboarding.

List of template endpoint

This GET request returns a list of flexible onboarding templates containing the Company's Admin steps to onboard the new employee.

After selecting a suitable template from the List of templates returned, the Company's Admin in this phase completes a series of steps, which are:

1. Employee basic information is the first dialog in the wizard that opens after selecting or modifying a template. The newly-hired employee's personal information, like the first and last name, email address, etc., is usually filled in here. You can find more information about this step here.
2. Employment basic information is where basic information about the employment of the newly-hired employee is found. This information may include the employee's start date, among others.
3. Employment detail information is where you fill in the employment details of the newly-hired employee in the system. These details include the employee's work location, work schedule, and compensation types. Please find more information about this step here.

After completing these steps, the Company's Admin can now call the Generate URL endpoint.

Generate URL for new employee endpoint

This is a GET request that returns an invitational URL for the employee to continue their phase of the onboarding process by sending the URL to their email address in the system.

Successfully onboarding the newly-hired employee returns a unique onboarding ID. This helps identify the employee's onboarding for making necessary updates and corrections and possibly terminating the employee's employment.