Get the company's onboarding status

GET {{baseUrl}}/v1/companies/:company_uuid/onboarding_status

Get company's onboarding status. The data returned helps inform the required onboarding steps and respective completion status.

scope: company_onboarding_status:read

HEADERS

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"]}]}