Blocks

Compensation

Onboarding step for collecting an employee's role and compensation details.

Remarks

Collects the job title, employee type (hourly, salary), compensation amount, and pay period. For hourly employees, allows configuring multiple roles. Automatically routes between editing the only job (when an employee has zero or one non-Nonexempt job) and a jobs-list view (when multiple roles need to be managed) on first mount; on subsequent refetches the user stays on their current step.

Example

import { EmployeeOnboarding } from '@gusto/embedded-react-sdk'

function MyComponent() {
  return (
    <EmployeeOnboarding.Compensation
      employeeId="4b3f930f-82cd-48a8-b797-798686e12e5e"
      startDate="2025-01-01"
      onEvent={() => {}}
    />
  )
}

CompensationProps

Props for Compensation.

Property	Type	Description
employeeId	string	The associated employee identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
startDate	string	The date the employee will start work.
defaultValues?	CompensationDefaultValues	Default values for the compensation form fields. If employee data is available via the API, these values are overwritten.
dictionary?	Record<"en", DeepPartial<EmployeeCompensation>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
employee/job/created	Fired after a job is successfully created	Job
employee/job/updated	Fired after a job is successfully updated	Job
employee/job/deleted	Fired after a job is successfully deleted	—
employee/compensation/updated	Fired after compensation details are updated	Compensation
employee/compensation/done	Fired when compensation setup is complete and the parent flow can advance	—

Endpoints

Method	Path
GET	/v1/companies/:companyId/federal_tax_details
PUT	/v1/compensations/:compensationId
DELETE	/v1/compensations/:compensationId
GET	/v1/employees/:employeeId
GET	/v1/employees/:employeeId/jobs
POST	/v1/employees/:employeeId/jobs
GET	/v1/employees/:employeeId/work_addresses
PUT	/v1/jobs/:jobId
DELETE	/v1/jobs/:jobId
POST	/v1/jobs/:jobId/compensations
GET	/v1/locations/:locationUuid/minimum_wages

---

Deductions

Onboarding step for collecting an employee's post-tax deductions and court-ordered garnishments.

Remarks

Renders the employee's current deductions as a list, with an empty state when none exist. Users add or edit deductions inline — post-tax custom deductions or court-ordered garnishments — and can complete the step with or without any active deductions.

Example

import { EmployeeOnboarding } from '@gusto/embedded-react-sdk'

function MyComponent() {
  return (
    <EmployeeOnboarding.Deductions
      employeeId="4b3f930f-82cd-48a8-b797-798686e12e5e"
      onEvent={() => {}}
    />
  )
}

DeductionsProps

Props for Deductions.

Property	Type	Description
employeeId	string	The associated employee identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<EmployeeDeductions>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
employee/deductions/add	Fired when the user opens the form to add a new deduction	—
employee/deductions/edit	Fired when the user opens the form to edit an existing deduction	The matching Garnishment
employee/deductions/created	Fired after a new deduction is saved	The created Garnishment
employee/deductions/updated	Fired after an existing deduction is updated	The updated Garnishment
employee/deductions/deleted	Fired after a deduction is deleted and others remain	The deleted Garnishment
employee/deductions/deletedEmpty	Fired after the last deduction is deleted, leaving none	—
employee/deductions/cancel	Fired when the user cancels the form while other deductions exist	—
employee/deductions/cancelEmpty	Fired when the user cancels the form and no deductions remain	—
employee/deductions/done	Fired when the step is complete and the parent flow can advance	—

Endpoints

Method	Path
GET	/v1/employees/:employeeId/garnishments
POST	/v1/employees/:employeeId/garnishments
PUT	/v1/garnishments/:garnishmentId
GET	/v1/garnishments/child_support

---

DocumentList

Lists the employee's documents pending signature.

Remarks

Fetches the employee's forms and renders the list of documents that still require signing along with a continue action once everything is signed.

Each form's description is rendered as returned by the API, unless the dictionary prop supplies a forms.<name>.description override for that form's name (e.g. forms.employee_direct_deposit.description).

DocumentListProps

Props for DocumentList.

Property	Type	Description
employeeId	string	The associated employee identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<EmployeeDocumentSigner>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
employee/forms/view	Fired when a form's "Sign" action is selected	{ uuid: string; name?: string }
employee/forms/done	Fired when all required forms have been signed and the parent flow can advance	—

Endpoints

Method	Path
GET	/v1/employees/:employeeId/forms

---

DocumentSigner

Onboarding step for signing employee documents.

Remarks

Lists the employee's pending forms and routes through the signing UI for each one. When withEmployeeI9 is true and the employee's I-9 has not been signed, the flow starts on the I-9 employment eligibility step before presenting the document list.

Each form's description is rendered as returned by the API, unless the dictionary prop supplies a forms.<name>.description override for that form's name (e.g. forms.employee_direct_deposit.description).

DocumentSignerProps

Props for DocumentSigner.

Property	Type	Description
employeeId	string	The associated employee identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<EmployeeDocumentSigner>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
withEmployeeI9?	boolean	When true, the flow routes through I-9 employment eligibility before listing documents for signing. Defaults to false.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
employee/employmentEligibility/done	Fired after I-9 employment eligibility is captured	The updated I-9 authorization
employee/forms/view	Fired when a form's "Sign" action is selected from the document list	{ uuid: string; name?: string }
employee/forms/sign	Fired after a form is successfully signed	APIModels.Form
employee/employmentEligibility/change	Fired when the user requests to change their I-9 eligibility status	—
employee/forms/done	Fired when all required forms have been signed and the parent flow can advance	—
cancel	Fired when the user cancels signing a form and returns to the document list	—

Components

• EmploymentEligibility
• I9SignatureForm
• DocumentList
• SignatureForm

Endpoints

Method	Path
GET	/v1/employees/:employeeId
GET	/v1/employees/:employeeId/forms
GET	/v1/employees/:employeeId/forms/:formId
GET	/v1/employees/:employeeId/forms/:formId/pdf
PUT	/v1/employees/:employeeId/forms/:formId/sign
GET	/v1/employees/:employeeId/i9_authorization
PUT	/v1/employees/:employeeId/i9_authorization

---

EditCompensation

Renders a form for creating or editing one of an employee's jobs together with its compensation.

Remarks

The submit chain saves the job first, then the compensation. The employee/job_created or employee/job_updated event fires once the job is saved; employee/compensation_updated fires once the compensation is saved and signals the full save is complete.

EditCompensationProps

Props for EditCompensation.

Property	Type	Description
employeeId	string	The associated employee identifier.
onEvent	OnEventType<EventType, unknown>	Event handler fired on flow state changes. See the events table on EditCompensation.
submitCtaLabel	string	Label for the primary submit button.
title	string	Heading text shown above the form.
currentJobId?	string | null	Existing job to edit. When omitted, a new job is created on submit.
dictionary?	Record<"en", DeepPartial<EmployeeCompensation>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
LoaderComponent?	LoaderComponentType	Custom loading indicator rendered while this component's async data is fetching. Overrides the indicator configured on GustoProvider for this instance only.
onCancel?	() => void	Optional handler invoked when the secondary cancel button is clicked.
partnerDefaultValues?	CompensationDefaultValues	Initial values for the job title and compensation fields.
startDate?	string	When provided, the hire date is pre-filled from this value and the hire date field is hidden. When absent, the hire date field is rendered so it can be set explicitly.

Inherits children, className, defaultValues from CommonComponentInterface.

Events

Event	Description	Data
employee/job_created	Fired when a new job is saved.	The saved Job.
employee/job_updated	Fired when an existing job is saved.	The saved Job.
employee/compensation_updated	Fired when the compensation is saved. Treat as the "save complete" signal.	The saved Compensation.

---

EmployeeDocuments

Onboarding step for selecting which documents the employee must complete.

Remarks

Shows the I-9 toggle when the employee is self-onboarding (so the employee can choose whether their employer will collect I-9 verification) and a summary otherwise. Persists the selection to the employee's onboarding documents configuration and advances the parent flow.

EmployeeDocumentsProps

Props for EmployeeDocuments.

Property	Type	Description
employeeId	string	The associated employee identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<EmployeeEmployeeDocuments>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
employee/onboardingDocumentsConfig/updated	Fired after the employee's documents configuration is saved	The updated documents configuration response
employee/documents/done	Fired when the step is complete and the parent flow can advance	—

Endpoints

Method	Path
GET	/v1/employees/:employeeId
PUT	/v1/employees/:employeeId/onboarding_documents_config

---

EmployeeList

Renders a paginated list of a company's employees with per-row onboarding actions (edit, delete, review, cancel self-onboarding) and an "Add employee" entry point.

EmployeeListProps

Props for EmployeeList.

Property	Type	Default value	Description
companyId	string		The associated company identifier.
onEvent	OnEventType<EventType, unknown>		Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<EmployeeEmployeeList>>		Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
showContinueButton?	boolean	false	Controls visibility of the Continue button in the employee list. Remarks When true, displays a Continue button below the populated employee list and a Skip button in the empty state. These controls trigger the employee/onboarding/done event, allowing navigation to the next step in a multi-step flow (e.g., company onboarding). When false (default), hides both buttons. Use this when the employee list is the final destination in its flow and no further navigation is needed (e.g., standalone employee onboarding where the list is the terminal screen).

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
employee/create	Fired when the user clicks "Add employee".	—
employee/update	Fired when the user selects "Edit" or "Review" on a row.	{ employeeId: string, onboardingStatus?: OnboardingStatus }
employee/deleted	Fired after a row's delete action completes.	{ employeeId: string }
employee/onboardingStatus/updated	Fired after the "Review" or "Cancel self-onboarding" action updates an employee's onboarding status.	The updated EmployeeOnboardingStatus record
employee/onboarding/done	Fired when the user clicks the skip/done control to leave the onboarding employee list.	—

Endpoints

Method	Path
GET	/v1/companies/:companyId/employees
DELETE	/v1/employees/:employeeId
PUT	/v1/employees/:employeeId/onboarding_status

---

EmploymentEligibility

Captures the employee's I-9 employment eligibility (Section 1) before signing.

Remarks

Collects the employee's authorization status — U.S. citizen, noncitizen national, permanent resident, or alien authorized to work — and any document details required for that status. Updates the employee's I-9 authorization record on submit.

EmploymentEligibilityProps

Props for EmploymentEligibility.

Property	Type	Description
employeeId	string	The associated employee identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<EmployeeEmploymentEligibility>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
employee/employmentEligibility/done	Fired after the I-9 authorization is saved	The updated I-9 authorization

Endpoints

Method	Path
GET	/v1/employees/:employeeId/i9_authorization
PUT	/v1/employees/:employeeId/i9_authorization

---

FederalTaxes

Onboarding step for collecting an employee's federal tax (W-4) withholdings — filing status, multiple-jobs flag, dependents, other income, deductions, and extra withholding.

Remarks

The federal tax record is created automatically with the employee, so this step is always in update mode. Only the revised 2020 W-4 format is supported. All fields are required by the bundled form, mirroring the IRS-form UX.

FederalTaxesProps

Props for FederalTaxes.

Property	Type	Description
employeeId	string	The associated employee identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked when the block emits an event. See the events table on FederalTaxes for the available event types and payloads.
defaultValues?	Partial<FederalTaxesFormData>	Pre-fill form values. Server data takes precedence when the employee already has values on file.
dictionary?	Record<"en", DeepPartial<EmployeeFederalTaxes>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
employee/federalTaxes/updated	Fired after the form is saved	The updated EmployeeFederalTax entity
employee/federalTaxes/done	Fired after a successful save so the parent flow can advance	—

Endpoints

Method	Path
GET	/v1/employees/:employeeUuid/federal_taxes
PUT	/v1/employees/:employeeUuid/federal_taxes

---

I9SignatureForm

Presents the employee's I-9 form for review and signature.

Remarks

Renders the I-9 PDF, surfaces the current employment-eligibility status, and collects the employee's signature along with any preparer or translator details. On successful submission the signed form is emitted.

I9SignatureFormProps

Props for I9SignatureForm.

Property	Type	Description
employeeId	string	The associated employee identifier.
formId	string	The identifier of the I-9 form to sign.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<EmployeeI9SignatureForm>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
employee/forms/sign	Fired after the I-9 is successfully signed	APIModels.Form
employee/employmentEligibility/change	Fired when the user requests to change their I-9 eligibility status	—
cancel	Fired when the user cancels signing and returns to the document list	—

Endpoints

Method	Path
GET	/v1/employees/:employeeId/forms/:formId
GET	/v1/employees/:employeeId/forms/:formId/pdf
PUT	/v1/employees/:employeeId/forms/:formId/sign
GET	/v1/employees/:employeeId/i9_authorization

---

JobsList

Lists an employee's jobs alongside their compensation details, with controls to add, edit, or remove a job.

Remarks

Used for employees who hold multiple roles. The primary job's FLSA classification determines whether the employee is treated as exempt or nonexempt.

JobsListProps

Property	Type	Description
employeeId	string	The associated employee identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<EmployeeCompensation>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
employee/job/add	Fired when the user chooses to add a job	none
employee/job/edit	Fired when the user chooses to edit a job	{ uuid: string }
employee/job/deleted	Fired after a job is successfully deleted	none
employee/compensations/done	Fired when the user continues past the jobs list	none

Endpoints

Method	Path
GET	/v1/employees/:employeeId/jobs
DELETE	/v1/jobs/:jobId

---

Landing

Landing page for the employee self-onboarding flow. Displays a welcome message and the list of onboarding steps the employee needs to complete.

LandingProps

Props for the Landing component.

Property	Type	Description
employeeId	string	UUID of the employee entering the self-onboarding flow.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
companyId?	string	Deprecated UUID of the company the employee belongs to.
dictionary?	Record<"en", DeepPartial<EmployeeLanding>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Endpoints

Method	Path
GET	/v1/employees/:employeeId

---

OnboardingSummary

Displays a summary of an employee's onboarding status, listing completed and outstanding steps. Rendered as a standalone step inside OnboardingFlow.

OnboardingSummaryProps

Props for OnboardingSummary.

Property	Type	Description
employeeId	string	The associated employee identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<EmployeeOnboardingSummary>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
isAdmin?	boolean	When true, renders the admin-facing view of the onboarding summary. Defaults to false.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Endpoints

Method	Path
GET	/v1/employees/:employeeId
GET	/v1/employees/:employeeId/onboarding_status

---

PaymentMethod

Onboarding step for setting up an employee's payment method.

Remarks

Lets the employee (or admin acting on their behalf) choose between Direct Deposit and Check, add bank accounts, and configure split-paycheck allocations across multiple accounts.

Example

import { EmployeeOnboarding } from '@gusto/embedded-react-sdk'

function MyComponent() {
  return (
    <EmployeeOnboarding.PaymentMethod
      employeeId="4b3f930f-82cd-48a8-b797-798686e12e5e"
      onEvent={() => {}}
    />
  )
}

PaymentMethodProps

Props for PaymentMethod.

Property	Type	Description
employeeId	string	The associated employee identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
defaultValues?	undefined	Not used — onboarding payment method editing operates on live data.
dictionary?	Record<"en", DeepPartial<EmployeePaymentMethod>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
isAdmin?	boolean	Whether the current viewer is an admin. Defaults to false.

Inherits children, className, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
employee/paymentMethod/updated	Fired after the payment method is saved	The updated payment method
employee/paymentMethod/done	Fired when payment method setup is complete and the parent flow can advance	—
employee/bankAccount/created	Fired after a bank account is successfully added	The created bank account
employee/bankAccount/deleted	Fired after a bank account is successfully removed	—

Endpoints

Method	Path
GET	/v1/employees/:employeeId/bank_accounts
POST	/v1/employees/:employeeId/bank_accounts
DELETE	/v1/employees/:employeeId/bank_accounts/:bankAccountUuid
GET	/v1/employees/:employeeId/payment_method
PUT	/v1/employees/:employeeId/payment_method

---

Profile

Onboarding step for collecting an employee's basic profile and addresses.

Remarks

Switches between an admin-facing variant (collects employee details, work address, start date, and an optional self-onboarding invitation toggle) and an employee-facing variant (collects employee details and home address only — the active work address is read-only) based on isAdmin. Both variants create the employee on submit when employeeId is omitted.

ProfileProps

Props for Profile.

Property	Type	Description
companyId	string	The associated company identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
defaultValues?	ProfileDefaultValues	Pre-fill values for the form fields.
dictionary?	Record<"en", DeepPartial<EmployeeProfile>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
employeeId?	string	The associated employee identifier. Omit to create a new employee.
isAdmin?	boolean	When true, renders the admin variant (collects work address, start date, and self-onboarding toggle). Defaults to false.
isSelfOnboardingEnabled?	boolean	When true, the admin variant exposes the self-onboarding toggle. Defaults to true.

Inherits children, className, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
employee/created	Fired after an employee is successfully created	APIModels.Employee
employee/updated	Fired after an employee is successfully updated	APIModels.Employee
employee/onboardingStatus/updated	Fired when toggling self-onboarding changes the employee's onboarding status (admin variant)	The updated onboarding status
employee/homeAddress/created	Fired after the home address is created	APIModels.EmployeeAddress
employee/homeAddress/updated	Fired after the home address is updated	APIModels.EmployeeAddress
employee/workAddress/created	Fired after the work address is created (admin variant)	APIModels.EmployeeWorkAddress
employee/workAddress/updated	Fired after the work address is updated (admin variant)	APIModels.EmployeeWorkAddress
employee/profile/done	Fired when all profile saves complete and the parent flow can advance	APIModels.Employee extended with startDate (admin variant)

Endpoints

Method	Path
POST	/v1/companies/:companyId/employees
GET	/v1/companies/:companyId/locations
GET	/v1/employees/:employeeId
PUT	/v1/employees/:employeeId
GET	/v1/employees/:employeeId/home_addresses
POST	/v1/employees/:employeeId/home_addresses
PUT	/v1/employees/:employeeId/onboarding_status
GET	/v1/employees/:employeeId/work_addresses
POST	/v1/employees/:employeeId/work_addresses
GET	/v1/home_addresses/:homeAddressUuid
PUT	/v1/home_addresses/:homeAddressUuid
GET	/v1/work_addresses/:workAddressUuid
PUT	/v1/work_addresses/:workAddressUuid

---

SignatureForm

Presents a single employee document for review and signature.

Remarks

Renders the form's PDF and collects the employee's signature. On successful submission the signed form is emitted; cancelling returns to the document list.

SignatureFormProps

Props for SignatureForm.

Property	Type	Description
employeeId	string	The associated employee identifier.
formId	string	The identifier of the form to sign.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<EmployeeDocumentSigner>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
employee/forms/sign	Fired after the form is successfully signed	APIModels.Form
cancel	Fired when the user cancels signing and returns to the document list	—

Endpoints

Method	Path
GET	/v1/employees/:employeeId/forms/:formId
GET	/v1/employees/:employeeId/forms/:formId/pdf
PUT	/v1/employees/:employeeId/forms/:formId/sign

---

StateTaxes

Onboarding step that collects an employee's per-state tax withholding answers. The set of fields is driven by the API response for each state on record.

StateTaxesProps

Props for StateTaxes.

Property	Type	Description
employeeId	string	The associated employee identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<EmployeeStateTaxes>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
isAdmin?	boolean	Render admin-only questions and submit them. Defaults to false.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
employee/stateTaxes/updated	Form was submitted successfully	{ employeeStateTaxesList: EmployeeStateTaxesList[] }
employee/stateTaxes/done	Onboarding step has finished — emitted immediately after updated	—

Endpoints

Method	Path
GET	/v1/employees/:employeeUuid/state_taxes
PUT	/v1/employees/:employeeUuid/state_taxes

---

Utility types

CompensationDefaultValues

CompensationDefaultValues = RequireAtLeastOne<{ flsaStatus?: FlsaStatusType; paymentUnit?: typeof PAY_PERIODS[keyof typeof PAY_PERIODS]; rate?: Job["rate"]; title?: Job["title"]; }>

Default values for the compensation form fields.

Remarks

At least one of the fields must be provided. If employee data is available via the API, these values are overwritten.

---

OnboardingDefaultValues

OnboardingDefaultValues = RequireAtLeastOne<{ compensation?: CompensationDefaultValues; profile?: ProfileDefaultValues; }>

Default values for the onboarding flow's per-step form components.

Remarks

At least one of the step-level keys must be provided. Per-step values are forwarded to the matching step component (e.g. profile to Profile, compensation to Compensation). If employee data is available via the API, the corresponding values are overwritten.

---

OnboardingExecutionInitialState

OnboardingExecutionInitialState = "employeeProfile"

The set of steps OnboardingExecutionFlow can be started on.

---

ProfileDefaultValues

ProfileDefaultValues = RequireAtLeastOne<{ employee?: RequireAtLeastOne<{ dateOfBirth?: string; email?: string; firstName?: string; lastName?: string; middleInitial?: string; }>; homeAddress?: RequireAtLeastOne<{ city?: string; state?: string; street1?: string; street2?: string; zip?: string; }>; inviteEmployeeDefault?: boolean; }>

Pre-fill values for the Profile onboarding step.

Remarks

At least one of the listed fields must be provided. When employee data is already available via the API, those values take precedence over the defaults.