CHcheckhq

Company Onboard

Changed on

Generates a link to Onboard a Company. Onboard links can also be embedded like Components. Check out our <a href="https://docs.checkhq.com/docs/adding-check-onboard-to-your-application" target="_blank">guide</a> on how to embed them into your app.

post/companies/{company}/onboard

Request

Path parameters

companystring required

ID of the company for which an onboard 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

200

urlstring

Example response

{
  "url": "{one_time_onboard_link}"
}

Changes