GuidesReferenceChangelogAPI Upgrades
Reference

Setup

The Setup resource represents a company's progress through embedded setup.

Concepts

Setup completion: A setup is completed when the company's first payroll moves to a processing status, indicating that the company has successfully completed their payroll setup.

Setup closure: A setup is closed if payroll setup is ended. A setup would be closed if a customer decided not to move forward with their payroll migration.

Profile: The setup profile reads in important fields from the company's enrollment profile that we consider during setup. It is read-only. You can use it to help organize the important setup-related information that you send to the enrollment profile.

Setup Due: The setup_due field indicates when Check will complete our work on the setup. It is null until the preliminary_review phase is completed.

Phase: A setup phase represents a set of work Check will take during the payroll setup process. Phases occur sequentially in the following order:

  • preliminary_review
  • team_setup
  • final_steps

Setup object

AttributeDescription
id
string		Unique ID of the setup.
company
string		Company ID of the company being set up. Note: A company may be associated with multiple setups.
submitted_at
string		Date time the setup was submitted to Check.
completed_at
string		Date time the setup was completed.
closed_at
string		Date time the setup was closed.
profile objectObject that reads in the fields from the enrollment profile
phases
array of objects		Phases of the setup.

Phase object

AttributeDescription
name
string		Slug of the setup phase.
completed_at
string		Date time the setup phase was completed at.

Endpoints

Get a setup

List setups

Lifecycle

Once you have the added all the information needed to submit to setup, use the Request Embedded Setup endpoint. Once submitted, the submitted_at field on the setup will be populated and the phases array will show the three phases above.

To view all setups, use the list setups endpoint. This endpoint will return the setups in the most recently created order. You can additionally filter setups by company. There can only be one submitted, non-completed, and non-closed setup per company.

To view a specifc setup, use the get a setup endpoint.

An updated webhook with a setup topic will be sent when one of the following fields is updated:

  • Setup submitted_at
  • Setup completed_at
  • Setup closed_at
  • Setup phase completed_at

Sandbox behavior

In Sandbox, after requesting Embedded Setup for a company, every two minutes, we will automatically transition the company to the next phase. 12 minutes after submission, the company’s implementation_status will move to completed, which indicates the company is ready to run payroll. You will get a company updated webhook with the implementation status and the setup webhooks mentioned above.