Company Onboarding
Overview
The Company Onboarding workflow provides components for managing company-related onboarding tasks. These components can be used individually or composed into a complete workflow.
Using Company Subcomponents
Employee onboarding components can be used to compose your own workflow, or can be rendered in isolation. For guidance on creating a custom workflow, see docs on composition.
Available Subcomponents
- Company.IndustrySelect
- Company.DocumentSigner
Company.DocumentSigner
Provides an interface for company representatives to read and sign required company documents. The component handles document listing, signatory management, and document signing workflow.
import { Company } from '@gusto/embedded-react-sdk'
function MyComponent() {
return (
<Company.DocumentSigner companyId="a007e1ab-3595-43c2-ab4b-af7a5af2e365" onEvent={() => {}} />
)
}
Props
Name | Type | Description |
---|---|---|
companyId Required | string | The associated company identifier. |
signatoryId | string | ID of the signatory. When this is set and it matches the signatory ID of the currently saved signatory it is assumed the user is the signatory. This means fields are pre populated in the signature form with their information and they are able to sign documents. |
onEvent Required | See events table for available events. |
Events
Event type | Description | Data |
---|---|---|
COMPANY_VIEW_FORM_TO_SIGN | Fired when a user selects a form to sign from the document list | Called with response from get company form endpoint |
COMPANY_FORM_EDIT_SIGNATORY | Fired when user requests to change the document signatory | Called with response from create signatory endpoint |
COMPANY_FORMS_DONE | Fired when user completes the document signing process | None |
COMPANY_SIGN_FORM | Fired when a form is successfully signed | Response from the sign company form API request |
COMPANY_SIGN_FORM_DONE | Fired when the form signing process is complete | None |
COMPANY_SIGN_FORM_BACK | Fired when user navigates back from the signature form | None |
COMPANY_ASSIGN_SIGNATORY_MODE_UPDATED | Fired when the signatory assignment mode changes (create/invite) | Mode string ('create_signatory' or 'invite_signatory') |
COMPANY_ASSIGN_SIGNATORY_DONE | Fired when the signatory assignment process is complete | None |
COMPANY_SIGNATORY_CREATED | Fired when a new signatory is created successfully | Response from the create signatory API request |
COMPANY_SIGNATORY_UPDATED | Fired when an existing signatory is updated successfully | Response from the update signatory API request |
COMPANY_SIGNATORY_INVITED | Fired when a signatory is successfully invited to the company | Response from the invite signatory API request |
Updated 2 days ago