Company Progress Tracker Component

Generates a Full Service Setup Progress Tracker component used to monitor Check's progress in setting up a Full Service Setup Company and allows users to resolve potential blocking issues raised by Check operators during the setup process.

post/companies/{company}/components/progress_tracker

Request

Base URL
https://sandbox.checkhq.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/checkhq/apis/check-api/docs/companies/:company/components/progress_tracker/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

companystring required

ID of the company for which an onboard link will be generated

Request body

emailstring

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

Response

200

urlstring

Example response

{
  "url": "{one_time_onboard_link}"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.