Company Previous Payroll Provider Access

Generates a Previous Payroll Provider Access component used to gain access to a company's previous provider for migration.

post/companies/{company}/components/previous_provider_access (COPY)

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/previous_provider_access%20(COPY)/post.ts
A function with typed inputs. Its response is checked against the schema.

companystring required

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

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

200

urlstring

{
  "url": "{one_time_onboard_link}"
}