GuidesReferenceChangelogAPI Upgrades
Reference
Start typing to search…

Create an employee

post
https://sandbox.checkhq.com/employees

Creates an employee.

Body Params
string

Employee's first name

string

Employee's middle name, if available

string
required

Employee's last name

string

Employee's email address

date

Employee's date of birth. Until dob is added, it will show up as a blocking employee onboard step.

residence
object

Employee residence used for calculating state income taxes. Until residence is added, it will show up as a blocking employee onboard step. You may not unset residence once it is set.

string
required

ID of employee's company

date

Most recent start date of employment. Until start date is added, it will show up as a blocking employee onboard step.

date

Most recent date of employment termination. Will be set to null if a more recent start date is set.

string

ID of employee's net pay split

workplaces
array of strings
required

IDs of workplaces where the employee works. Optionally, an empty list can be passed in and workplaces can be added after employee creation. Until the workplaces are added, this will show up as a blocking step in the onboarding status.

workplaces*
string

The Workplace ID of the employee's primary workplace.

string

Employee's TIN (usually their Social Security Number). Must be unique across all employees in a company. Only the last four digits of an SSN will be made available in ssn_last_four after being set.

string

Either "direct_deposit" or "manual", default null

boolean
Defaults to true

Indicates whether the employee is currently employed. Used only for filtering.

boolean
Defaults to false

Indicates whether the employee has opted into electronic delivery of W2 PDF.

json

Additional loosely structured information to associate with the employee

Response

Updated 6 months ago

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