Finish company onboarding

PUT {{baseUrl}}/v1/companies/:company_uuid/finish_onboarding

Finalize a given company's onboarding process.

Approve a company in demo

After a company is finished onboarding, Gusto requires an additional step to review and approve that company. The company onboarding status is "onboarding_completed": false, until the API call is made to finish company onboarding. In production environments, this step is required for risk-analysis purposes.

We provide the endpoint PUT '/v1/companies/{company_uuid}/approve' to facilitate company approvals in the demo environment.

PUT '/v1/companies/89771af8-b964-472e-8064-554dfbcb56d9/approve'

# Response: Company object, with company_status: 'Approved'

scope: companies:write

HEADERS

KeyDatatypeRequiredDescription
X-Gusto-API-VersionstringDetermines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Acceptstring

RESPONSES

status: OK

{"uuid":"c44d66dc-c41b-4a60-9e25-5e93ff8583f2","onboarding_completed":false,"onboarding_steps":[{"title":"Add Your Company's Addresses","id":"add_addresses","required":true,"completed":true,"skippable":false,"requirements":[]},{"title":"Enter Your Federal Tax Information","id":"federal_tax_setup","required":true,"completed":true,"skippable":false,"requirements":[]},{"title":"Select Industry","id":"select_industry","required":true,"completed":true,"skippable":false,"requirements":[]},{"title":"Add Your Bank Account","id":"add_bank_info","required":true,"completed":true,"skippable":false,"requirements":[]},{"title":"Add Your Employees","id":"add_employees","required":true,"completed":true,"skippable":true,"requirements":["add_addresses"]},{"title":"Enter Your State Tax Information","id":"state_setup","required":true,"completed":false,"skippable":false,"requirements":["add_addresses","add_employees"]},{"title":"Select a Pay Schedule","id":"payroll_schedule","required":true,"completed":false,"skippable":false,"requirements":[]},{"title":"Sign Documents","id":"sign_all_forms","required":true,"completed":false,"skippable":false,"requirements":["add_employees","federal_tax_setup","state_setup","add_bank_info","payroll_schedule"]},{"title":"Verify Your Bank Account","id":"verify_bank_info","required":true,"completed":false,"skippable":false,"requirements":["add_bank_info"]}]}