ContractorOnboarding
Flows and blocks for onboarding contractors.
import { ContractorOnboarding } from '@gusto/embedded-react-sdk'
🚂 Workflows
| Component | Description |
|---|---|
| OnboardingFlow | Guided flow for admins to onboard a contractor to the company. |
| SelfOnboardingFlow | Guided flow for contractors to complete their own onboarding. |
🧩 Blocks
| Component | Description |
|---|---|
| Address | Form for collecting and updating a contractor's mailing address. Renders a business or home address title based on the contractor type. |
| ContractorList | Lists a company's contractors with controls to add, edit, delete, cancel self-onboarding, and continue onboarding. |
| ContractorProfile | Form for creating or editing a contractor profile, supporting both individual and business contractor types. |
| ContractorSubmit | Finalizes contractor onboarding by updating the onboarding status, and in the self-onboarding flow can trigger an invitation to the contractor. |
| DocumentSigner | Contractor onboarding step for reading and signing required contractor documents. |
| DocumentsList | Lists a contractor's documents and lets the contractor open each one for signing. |
| Landing | Landing page for the contractor self-onboarding flow. Displays a welcome message and the list of onboarding steps the contractor needs to complete. |
| NewHireReport | Collects new hire reporting information for a contractor and persists it to the contractor record. |
| OnboardingSummary | Confirmation screen shown at the end of the contractor self-onboarding flow. Lets the contractor know their information has been submitted and emits contractor/selfOnboarding/done when they acknowledge it. |
| PaymentMethod | Manages a contractor's payment method, capturing a bank account for direct deposit or recording check as the payment method. |
| SignatureForm | Standalone form for signing an individual contractor document (W-9). |