Launch integration

This Component allows employers to launch a first-party Check integration within your application.

post/companies/{company}/components/integrations

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/integrations/post.ts
A function with typed inputs. Its response is checked against the schema.

companystring required

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

integration_partnerstring required

ID of the integration partner you want to authorize

emailstring required

Email of the user granting permission

200

urlstring required

{
  "url": "{component_url}"
}