Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Employees

Update employee onboarding documents config

Indicate whether to include the Form I-9 for an employee during the onboarding process. If included, the employee will be prompted to complete Form I-9 as part of their onboarding.

Related guides

scope: employees:manage

put/v1/employees/{employee_id}/onboarding_documents_config

Path parameters

employee_idstring required

The UUID of the employee

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Request body

i9_documentboolean

Whether to include Form I-9 for this employee during onboarding. When true, the employee will be prompted to complete Form I-9 as part of their onboarding.

Response

Success

uuidstring nullable

The UUID of the onboarding documents config record. Null when no config has been saved yet.

i9_documentboolean

Whether to include Form I-9 for this employee during onboarding. When true, the employee will be prompted to complete Form I-9 as part of their onboarding.