CHcheckhq

Company Full Service Setup Submission Component

Changed on

This Component allows an employer to submit themselves to Check for Full Service Embedded Setup.

post/companies/{company}/components/full_service_setup_submission

Request

Path parameters

companystring required

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

Request body

signatorystring required

The ID of the signatory object for this company. You must provide either a signatory ID (recommended) or all three body params shown below

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

Example request

{
  "field_permissions": {
    "company:legal_name": "read",
    "company:trade_name": "read",
    "company:address": "read",
    "company:phone": "read",
    "company_tax_param:federal_ein": "read"
  }
}

Response

200

urlstring

Example response

{
  "url": "{component_url}"
}

Changes