Bulk employee creation in Console
Upload employee data in bulk using a CSV template in Console to streamline onboarding.
Partners can bulk upload employees by filling out a CSV template and uploading it to Console. This creates the employee object. The tool does not support the edit, update, and deletion of employee objects or the creation, edit, update, and deletion of contractor objects. The current version of this upload feature is limited to 25 employees at a time.
Before you begin, you will have to have created the company and its workplaces for which you’ll be creating employees.
File requirements: You will need the following data for all employees you would like to upload.
- First Name
- Middle Name
- Last Name [required]
- Residence Line 1 [required]
- Residence Line 2
- Residence City [required]
- Residence State [required]
- Residence Postal Code [required]
- SSN
- Payment Method Preference
- Active
- W2 Electronic Consent Provided
- Date of Birth [required]
- Start Date [required]
- Workplace IDs [required]
- Primary Workplace
Metadata
In order to associate employees created through this bulk upload feature to companies in your system, use the metadata object to make this corresponding linkage.
You can add metadata to the created employees by inserting columns into the spreadsheet that have “Metadata: “ prefixing the column headers. It’s important to note that the only columns that Check will accept are the ones included in the template or added by you with the “Metadata: “ header prefix.
For example, if you have internal company IDs and you want to associate the created employees with companies in your system by parsing the webhooks, you could add a column titled Metadata: company_id
The resulting employee would have a metadata object that looks like this:
"metadata": {
"company_id": "<Your company ID>"
}Webhooks
Check will send asynchronous webhooks for each employee in the bulk creation process. You can review the expected response as well as how to configure your webhook endpoints to accept these employee creation events.
Additionally, you'll need to ensure that you can parse the webhook body. After the upload, by using the webhook's information, you will be able to automatically create employees in your system through this flow.
Please reach out to us if you need any guidance or further instructions on setting up the necessary webhook endpoints for record association of newly created employees from Check to your system.
Bulk creating employees in Console
After fulfilling the prerequisites, Check will enable the bulk employee creation feature in your Console, and you’re now ready to begin using this feature!
- Download the bulk employee create template
- Fill in the necessary information in the provided CSV for every employee you want to create
- Double-check to avoid inputting anything that would cause the errors listed in the Error Handling section. Here’s an example of what would be displayed if you uploaded a sheet that didn’t have date of birth information.
- Save your updated CSV template
- Click the ‘Upload’ button
- Select the completed CSV you just created
- The interface will automatically update to show the new employees once they have been created in our system.
Error handling
This flow will display an error if any of the following cases occur:
- Missing required information (see File Requirements above)
- Attempting to upload a duplicate employee
- Uploading more than 25 employees
- Attempting to upload an employee who has a start date prior to 1/1/1950
- Providing a workplace ID that doesn’t exist on the company
- Providing a primary workplace ID that either doesn’t exist in the company or isn’t one of the employees’ workplaces
Errors from malformed data (e.g., address validation issue, incorrect date format) will display a similar error message to an employee creation request sent directly to the API.
Last updated on March 31, 2023