Company Team Setup

This Component allows an employer to set up and manage their workplaces, employees, and contractors.

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

Completion Event

When embedded on your page, this component can be closed once the check-component-team-setup-complete SDK event has been posted.


Additional SDK Events

Throughout a user's progress in this component, a few other SDK events will be emitted which you have the option to act on. More documentation about SDK events emitted from Check Components can be found here.

EventDescription
check-component-team-setup-workplace-setup-completeThis event will be posted when the user completes workplace setup which is the first step of team setup.
check-component-team-setup-employee-setup-completeThis event will be posted when the user completes employee setup which is the second step of team setup.
check-component-team-setup-contractor-setup-completeThis event will be posted when the user completes contractor setup which is the third step of team setup.

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