API Reference

Creates a new onboarding and returns the initial setup workflow metadata.

post
https://example.com/wep/companies//onboarding/start

Access: System, Admin, and ClientAdmin users only.

This endpoint supports standard onboarding creation, rehire onboarding creation, and ATS-driven onboarding initialization.
The response includes the created onboarding identifier, the ordered phase-1 step list, and metadata needed to render the next required step.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Company identifier from the route.

Body Params

Creation payload that selects the template and optional onboarding behaviors.

Request payload used to create a new onboarding.

int32 | null

Template identifier to use for the onboarding.
This field is required for standard and rehire onboarding creation flows.

string | null

URL to redirect the employee to after the last employee-side step is completed.
This value is required when Worklio.ApiModels.API.Models.Clients.Onboarding.Inputs.StartModel_v10.SpecialActions contains Worklio.ApiModels.API.Models.Clients.Onboarding.Enums.SpecialAction.P2RedirectToFinishUrl.

int32
enum

Definitions for Special actions for Employee Onboarding

Members:

  • 1 - DisableErEmails ( Onboarding doesn't sent emails to Employer. )
  • 2 - P2AfterLoginGo2FirstUnfinishStep ( Phase 2: When an employee signs into Onboarding, then he will be automatically redirected to the first unfinished step. )
  • 4 - P2RedirectToFinishUrl ( Phase 2: When an employee finished last step, then he will be automatically redirected to the EeFinishUrl. )
  • 8 - AutoApproveEeStepEmpSummaryApproval ( Phase 2: When employee signed into Onboarding, then step EmploymentApprovalEe will automatically approved. )
  • 16 - P2DisableAuthentication ( Phase 2: Employee will automatically signed into Onboarding by RCU from Url. )
  • 32 - DisableReportWrongData ( Phase 2: Employee doesn't have choice Report Wrong Data on step Employment Summary Approval. )
  • 64 - EeForceESignature ( Phase 2: All documents that employees must sign will automatically signed electronically.. )

Allowed:
int32 | null

Existing employee identifier to reuse when the onboarding is created as a rehire.

externalSource
object

Identifies the upstream system that supplied onboarding source data.

string | null

External unique identifier that should be copied onto the created onboarding.

boolean | null

Enables the employer-side document configuration step during phase 1 when set to true.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

Responses

Updated about 1 month ago

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago