This Component allows an employer to view, add, edit, and remove their workplaces.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
The Workplace Roster Component is the workplace roster of the Company Team Setup Component, available on its own. Use it when you want to give an employer a place to manage their workplaces without stepping them through the full workplace → employee → contractor setup sequence.
A workplace is a taxable jurisdiction in which a company does business.
To mint it, make the same call you make for Company Team Setup with /workplaces appended to the path:
POST /companies/{company_id}/components/team_setup/workplacesThe request body and the response are unchanged from Company Team Setup — you get back a url that you embed the same way as any other Check Component.
Related ComponentsThe employee and contractor rosters are available on their own as the Employee Roster and Contractor Roster Components. To surface workplaces, employees, and contractors together in a single guided flow, use Company Team Setup.
Differences from Company Team Setup
Because this Component is scoped to a single roster rather than a setup sequence, it behaves slightly differently than the workplace step inside Company Team Setup:
| Behavior | Workplace Roster | Company Team Setup |
|---|---|---|
| Step navigation | None — only the workplace roster is rendered. | "Continue" advances the user from workplaces to employees. |
| Completion | No completion confirmation, and no completion SDK event is emitted. | The user confirms their workplace list, emitting a completion event. |
Everything else — adding a workplace, editing a workplace, and removing a workplace — works exactly as it does inside Team Setup.
No completion eventThis Component does not emit the
check-component-team-setup-workplace-setup-completeSDK event —check-component-app-loadedis the only event it posts. Close it on your own UX cue rather than waiting on a completion event.
Not yet available in the ConsoleThis Component does not appear in the Console component dropdown yet. For now, mint it directly via the API.
If email is provided, the user can regenerate a link sent to that email if the component link is expired.