Get the contractor's onboarding status
GET {{baseUrl}}/v1/contractors/:contractor_uuid/onboarding_status
Retrieves a contractor's onboarding status. The data returned helps inform the required onboarding steps and respective completion status.
scope: contractors:read
onboarding_status
Admin-facilitated onboarding
| onboarding_status | Description |
|---|---|
admin_onboarding_incomplete | Admin needs to enter basic information about the contractor. |
admin_onboarding_review | All information has been completed and admin needs to confirm onboarding. |
onboarding_completed | Contractor has been fully onboarded and verified. |
Contractor self-onboarding
| onboarding_status | Description |
|---|---|
admin_onboarding_incomplete | Admin needs to enter basic information about the contractor. |
self_onboarding_not_invited | Admin has the intention to invite the contractor to self-onboard (e.g., marking a checkbox), but the system has not yet sent the invitation. |
self_onboarding_invited | Contractor has been sent an invitation to self-onboard. |
self_onboarding_started | Contractor has started the self-onboarding process. |
self_onboarding_review | Admin needs to review contractors's entered information and confirm onboarding. |
onboarding_completed | Contractor has been fully onboarded and verified. |
onboarding_steps
| onboarding_steps | Requirement(s) to be completed |
|---|---|
basic_details | Add individual contractor's first name, last name, social security number or Business name and EIN depending on the contractor type |
add_address | Add contractor address. |
compensation_details | Add contractor compensation. |
payment_details | Set up contractor's direct deposit or set to check. |
sign_documents | Contractor forms (e.g., W9) are generated & signed. |
file_new_hire_report | Contractor new hire report is generated. |
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. | |
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"]}]}