Update the employee's onboarding status

PUT {{baseUrl}}/v1/employees/:employee_id/onboarding_status

scope: employees:manage

Updates an employee's onboarding status. Below is a list of valid onboarding status changes depending on the intended action to be performed on behalf of the employee.

Request Body

{"onboarding_status"=>"<string>"}

HEADERS

RESPONSES

status: OK

{"uuid":"c44d66dc-c41b-4a60-9e25-5e93ff8583f2","onboarding_status":"admin_onboarding_incomplete","onboarding_steps":[{"title":"Personal details","id":"personal_details","required":true,"completed":false,"requirements":[]},{"title":"Enter compensation details","id":"compensation_details","required":true,"completed":false,"requirements":[]},{"title":"Add work address","id":"add_work_address","required":true,"completed":false,"requirements":[]},{"title":"Add home address","id":"add_home_address","required":true,"completed":false,"requirements":[]},{"title":"Enter federal tax withholdings","id":"federal_tax_setup","required":true,"completed":false,"requirements":[]},{"title":"Enter state tax information","id":"state_tax_setup","required":true,"completed":false,"requirements":["add_work_address","add_home_address"]},{"title":"Direct deposit setup","id":"direct_deposit_setup","required":false,"completed":false,"requirements":[]},{"title":"Employee form signing","id":"employee_form_signing","required":true,"completed":false,"requirements":["federal_tax_setup","state_tax_setup"]}]}