Change the contractor's onboarding status
PUT {{baseUrl}}/v1/contractors/:contractor_uuid/onboarding_status
Updates a contractor's onboarding status.
scope: contractors:write
Below is a list of valid onboarding status changes depending on the intended action to be performed on behalf of the contractor.
| Action | current onboarding_status | new onboarding_status |
|---|---|---|
| Mark a contractor as self-onboarding | admin_onboarding_incomplete | self_onboarding_not_invited |
| Invite a contractor to self-onboard | admin_onboarding_incomplete or self_onboarding_not_invited | self_onboarding_invited |
| Cancel a contractor's self-onboarding | self_onboarding_invited or self_onboarding_not_invited | admin_onboarding_incomplete |
| Review a contractor's self-onboarded info | self_onboarding_started | self_onboarding_review |
| Finish a contractor's onboarding | admin_onboarding_incomplete or self_onboarding_review | onboarding_completed |
Request Body
{"onboarding_status"=>"onboarding_completed"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"uuid":"bc57832c-d8bc-43a7-ae99-3a03380ff037","onboarding_status":"admin_onboarding_incomplete","onboarding_steps":[{"title":"Basic details","id":"basic_details","required":true,"completed":false,"requirements":[]},{"title":"Enter compensation details","id":"compensation_details","required":true,"completed":false,"requirements":[]},{"title":"Add an address","id":"add_address","required":true,"completed":false,"requirements":[]},{"title":"Payment details","id":"payment_details","required":true,"completed":false,"requirements":[]},{"title":"Sign and acknowledge documents","id":"sign_documents","required":false,"completed":false,"requirements":["basic_details,","add_address"]},{"title":"File new hire report","id":"file_new_hire_report","required":false,"completed":false,"requirements":["basic_details"]}]}