CHcheckhq

Workplace Roster

Changed on

This Component allows an employer to view, add, edit, and remove their workplaces. It is the workplace roster of the Company Team Setup Component, available as a standalone Component.

post/companies/{company}/components/team_setup/workplaces

Request

Path parameters

companystring required

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

Request body

signer_namestring

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

signer_titlestring

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

emailstring

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

signatorystring

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

Response

200

urlstring

Example response

{
  "url": "{component_url}"
}

Changes