Global Standard
Required Fields
| Field | Mandatory/Optional | Description | Format | Example |
|---|---|---|---|---|
| Company Tax ID | Mandatory for Multi Entities and Channel Partners | Identifies to which company an employee belongs | It can have special characters, but we will transform it, leaving only alphanumeric to identify the corresponding company | 00.623.904/0001-73 → 00623904000173 |
| Mandatory (as single eligibility identifier) | It must be unique for the same company tax id; at the at the multi-entity and channel partner-level, duplicates are accepted | There is no validation if the email exists, but the format is validated (including the company domain), and there isn’t a limit of characters | a@b.com john.doe@gympass.com | |
| Employee ID | Mandatory if Employee ID + National ID as eligibility identifiers (Email as optional) | It must be unique for the same company tax id; at the multi-entity and channel partner-level, duplicates are accepted | It’s an alphanumeric field required to have at least 8 characters | 123 John.doe |
| National ID | Mandatory if Employee ID + National ID as eligibility identifiers (Email as optional) | It must be unique for the same company tax id; at the multi-entity and channel partner-level, duplicates are accepted | It’s an alphanumeric field, and its validation depends on the company's country - it refers to the employees tax id (e.g. in Brazil CPFs are requested). Format and logical validations are performed | 11122233396 AB1234FA43 |
| Name | Optional | This field helps engagement on our communications (Invitation to Sign Up, for example) | There is no validation on the name and no character limit | John Doe |
| Payroll Enabled | Optional | It's a boolean column (Yes/No) to allow the clients to manage the employees allowed to use paycheck as a payment method (not managed by the client) | Yes or No | Yes |
| Payroll ID | Optional | This identifier helps the client find the employee in their payroll software | It’s an alphanumeric (and specials) field without a character limit | 2953ACV@ZF |
| Cost Center | Optional | This represents the employee's cost center | It’s an alphanumeric (and specials) field without a character limit | |
| Department | Optional | This represents the employee's department | It’s an alphanumeric (and specials) field without a character limit | |
| Office zip code | Optional | This represents the employee's office zip code | It’s an alphanumeric (and specials) field without a character limit | |
| Discount group | Mandatory for clients with Wellhub+ 2.0 | The value must correspond to the discount groups created | It’s a numeric field, if empty the discount group will be removed from the eligible | 1 |
Header Record
The Header Record must be included in the file. The Attribute Names (column titles) must be written exactly as indicated in the specification table above.
Data Record
Mandatory Fields
Generally, Wellhub requires each of these fields to be included for Wellhub to have the necessary information required to validate eligible employees and to assist in program communications with employees. However, there may be special cases, for example when an employee does not have an email address, that can be accommodated. If you cannot provide this data for all your employees, please consult with your Wellhub Sales and Technical Sales representatives.
If you have any questions on this, consult your Wellhub Customer Success representative.
Format Notes
- The header is mandatory, and needs to be in English for all countries
- The column order is not mandatory
- The column titles (attribute names) must be written exactly as indicated in the document
- Unknown columns will be ignored
- The CSV can use any of the accepted separators, as: comma ( , ), semicolon ( ; ), tab, and space
- CSV UTF-8 is the format supported