Contractor Roster

This Component allows an employer to view, add, edit, and remove the contractors on their team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The Contractor Roster Component is the contractor 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 1099 contractors 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 /contractors appended to the path:

POST /companies/{company_id}/components/team_setup/contractors

The 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 Components

The workplace and employee rosters are available on their own as the Workplace Roster and Employee 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 contractor step inside Company Team Setup:

BehaviorContractor RosterCompany Team Setup
Step navigationNone — only the contractor roster is rendered."Continue" completes the Team Setup flow.
CompletionNo completion confirmation, and no completion SDK event is emitted.The user confirms their contractor list, emitting completion events.

Everything else — adding a contractor, editing a contractor, and removing a contractor — works exactly as it does inside Team Setup.

🚧

No completion event

This Component does not emit the check-component-team-setup-contractor-setup-complete or check-component-team-setup-complete SDK eventscheck-component-app-loaded is the only event it posts. Close it on your own UX cue rather than waiting on a completion event.


🚧

Not yet available in the Console

This 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.

Path Params
string
required

ID of the company for which a component link will be generated

Body Params
string

The name of the person who has permission to onboard on behalf of the company.

string

The title of the person who has permission to onboard on behalf of the company (e.g. "Officer", "Manager", etc.).

string

The email of the person who has permission to onboard on behalf of the company

string

The ID of the signatory object for this company. You may use either a signatory ID or the three body params above

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json