CHcheckhq

Company Details

Changed on

This Component allows employers to enter information about their business for due diligence review to determine payroll product and feature eligibility <img style="margin-top: 30px; margin-bottom: 20px;" src="https://public-component-assets.s3.amazonaws.com/er_details.svg" /> Learn how to embed Components in our <a target="_blank" href="https://docs.checkhq.com/docs/embedding-a-component">guide</a>.

post/companies/{company}/components/details

Request

Path parameters

companystring required

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

Request body

signer_namestring required

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

signer_titlestring required

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

emailstring required

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

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

201

urlstring

Example response

{
  "url": "{component_url}"
}

Changes