API Reference

Start new employee onboarding

post
https://api.worklio.com/wep/companies//onboarding/start
Path Params
int32
required
Body Params
int32 | null
string | null

URL address - for redirecting employee to another site when he finishes last step This value is mandatory when input parameter SpecialActions contains value 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

Rehire Employee Id

externalSource
object
string | null

External Source UID

boolean | null

Enable Documents step in Onboarding Phase 1

Headers
string
Defaults to 1.0

The requested API version

string
Defaults to 1.0

The requested API version

Responses

Updated 7 months ago

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