GuidesReferenceChangelogAPI Upgrades
Reference

Company Previous Payroll Provider Access

post
https://sandbox.checkhq.com/companies//components/previous_provider_access

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

This component is only available for usage with Check Embedded Setup. Reach out to Check for more information.

📘

Completion Event

When embedded on your page, this component can be closed once the check-component-previous-provider-access-complete SDK event has been posted.


If email is provided, the user can regenerate a link sent to that email if the component link is expired.

Path Params
string
required

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

Body Params
string
required

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

string
required

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

string
required

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

string

The ID of the signatory object for this company. You may use either a signatory ID or the three body params above

Responses

Updated 9 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago