GuidesAPI ReferenceChangelogAPI PolicyAPI StatusGusto Security
API Reference

Get the contractor's 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_statusDescription
admin_onboarding_incompleteAdmin needs to enter basic information about the contractor.
admin_onboarding_reviewAll information has been completed and admin needs to confirm onboarding.
onboarding_completedContractor has been fully onboarded and verified.

Contractor self-onboarding

onboarding_statusDescription
admin_onboarding_incompleteAdmin needs to enter basic information about the contractor.
self_onboarding_not_invitedAdmin 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_invitedContractor has been sent an invitation to self-onboard.
self_onboarding_startedContractor has started the self-onboarding process.
self_onboarding_reviewAdmin needs to review contractors's entered information and confirm onboarding.
onboarding_completedContractor has been fully onboarded and verified.

onboarding_steps

onboarding_stepsRequirement(s) to be completed
basic_detailsAdd individual contractor's first name, last name, social security number or Business name and EIN depending on the contractor type
add_addressAdd contractor address.
compensation_detailsAdd contractor compensation.
payment_detailsSet up contractor's direct deposit or set to check.
sign_documentsContractor forms (e.g., W9) are generated & signed.
file_new_hire_reportContractor new hire report is generated.
Language
Authorization
Bearer
Click Try It! to start a request and see the response here!