This Component allows an employer to view, add, edit, and remove the employees on their team.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
The Employee Roster Component is the employee 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 W-2 employees without stepping them through the full workplace → employee → contractor setup sequence.
To mint it, make the same call you make for Company Team Setup with /employees appended to the path:
POST /companies/{company_id}/components/team_setup/employeesThe 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 workplace and contractor rosters are available on their own as the Workplace 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 employee step inside Company Team Setup:
| Behavior | Employee Roster | Company Team Setup |
|---|---|---|
| Step navigation | None — only the employee roster is rendered. | "Continue" advances the user from employees to contractors. |
| Completion | No completion confirmation, and no completion SDK event is emitted. | The user confirms their employee list, emitting a completion event. |
Everything else — adding an employee, editing an employee, assigning workplaces, and removing an employee — works exactly as it does inside Team Setup.
No completion eventThis Component does not emit the
check-component-team-setup-employee-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.