post https://sandbox.checkhq.com/companies//request_embedded_setup
Request that Check manage setting up all of a Company's data necessary to begin running payroll.
Before this request can succeed, the Company must:
- Have agreed to Check TOS
- Completed bank account setup
- Have a
start_datein the future- In cases where we update the
start_dateto a different month, Federal Form 8655 will automatically be removed, and the onboard status will be set toblocking. Since this document displays thestart_datemonth, any updates that would alter the month would invalidate any previously signed Federal Form 8655s. We will then want to generate a new onboard or filing auth component link for the employee to re-sign a new Federal Form 8655.
- In cases where we update the
And the following fields must be populated:
start_datepay_frequency
previous_payroll_providerpayroll_history_access_method- When
payroll_history_access_methodisprovided_previous_payroll_provider_account_id, thenprevious_payroll_provider_account_idis also required
- When
employee_countcontractor_countaccount_contacts- the first email address in this array will be used for any setup-related communications from our team- (optional)
implementation_services_submission_comment
| Possible error messages |
|---|
| Company has not agreed to Terms of Service |
| Company must complete bank account setup |
| Company must have a start date |
| Company start date '2023-10-10' must be in the future |
| Company must have a pay frequency |
| Company must complete EnrollmentProfile to request Embedded Setup |
| Embedded Setup may only be used for companies migrating from a previous payroll provider |
| Company must affirm access to previous payroll provider via payroll_history_access_method on EnrollmentProfile |
| Company must provide estimated employee count on EnrollmentProfile |
| Company must provide estimated contractor count on EnrollmentProfile |
| Company has already been submitted for Embedded Setup |