> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The Employee Object

> The Employee Object represents a W-2 employee for a given company.

The Employee Object represents a W-2 employee for a given company.

| attribute | type | description |
| - | - | - |
| employeeID | string | Zeal Employee ID |
| companyID | string | Zeal Company ID of the employer |
| onboarded | boolean | Whether the employee has been onboarded onto Zeal or not |
| employment\_status | string | Employment status of the employee. Holds one of the following values:`live`: This employee currently works for this company and will receive payroll`leave`: This employee is "On Leave"`terminated`: This employee has been "Terminated". If terminated, must have `term_date`. (see below) |
| term\_date | string | Termination Date of the employee. The termination date is the day on which the employee and the employer end their relationship and is formatted as a date (YYYY-MM-DD)**NOTE: This field is required to mark an Employee as terminated if opted into Health Insurance (Early Access)** |
| term\_reason | string | Termination reason of the employee. Holds one of the following values: `voluntary`: This employee has voluntarily left the company `involuntary`: This employee has involuntarily left the company `death`: This employee is no longer with the company due to death `misconduct`: This employee is no longer with the company due to misconduct**NOTE: This field is required to mark an Employee as terminated if opted into Health Insurance (Early Access)** |
| benefits\_class | string | Class of employee used for Health Insurance eligibility. Holds one of the following values:`Full-Time`, `Part Time`, `Executive`, `VP`, `IT Staff`, `Eligible - No ER Contribution`, `On Site`, `Variable to Full Time`: Eligible for benefits and will receive an enrollment link`Ineligible`: **(Default)** Not eligible for benefits and will not receive an enrollment linkThere may be additional fields based on Health Insurance configuration.**NOTE: This field is only required if opted into Health Insurance (Early Access).** All benefit classes are available, only select and prompt benefit updates for classes you have confirmed with EVCO. |
| first\_name | string | First name of the employee |
| last\_name | string | Last name of the employee |
| title | string | Title of employee |
| dob | string | Date of birth of the employee |
| start\_date | string | Start Date of employee (also known as hire date). This is the first day that this employee works in return for wages and is formatted as a date (YYYY-MM-DD). Zeal uses this date for new hire reporting. |
| email | string | Email of employee |
| address | string | Residential Street address of the employee |
| address\_line2 | string | Residential Street Address Line 2 of employee (i.e. apt numbers, suite no., etc.) |
| city | string | Residential City of employee |
| state | string | Residential State of employee (US). Used when `country` is `US` |
| zip | string | Residential Zip code of the employee (US). Used when `country` is `US` |
| country | string | Country of the employee residence. One of `US` or `CA`. Defaults to `US` **NOTE: `CA` is only applicable for Canadian Payroll (Early Access)** |
| province | string | Canadian province/territory of the employee residence (2-letter abbreviation: `AB`, `BC`, `MB`, `NB`, `NL`, `NS`, `NT`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT`). Used when `country` is `CA` **NOTE: Only applicable for Canadian Payroll (Early Access)** |
| postal\_code | string | Canadian postal code of the employee residence. Used when `country` is `CA` **NOTE: Only applicable for Canadian Payroll (Early Access)** |
| phone\_number | string | Phone number of employee. Formatted with "+1" country code (e.g. `+18214370987`) |
| default\_pay\_schedule | string | Default pay schedule of the employee. See the different options [here](/reference/employee-checks/reporting-periods/pay-frequency-reporting-periods-and-check-dates) |
| default\_wage | number | Default wage of the employee |
| default\_ot\_wage | number | Wage for overtime pay. Default OT rate is 1.5 times base wage |
| default\_dt\_wage | number | Wage for double time pay. Default DT rate is 2 times base wage |
| ssn | string | Social security number of employee (US). Used when `country` is `US` |
| sin | string | Canadian Social Insurance Number (SIN). Accepts `123456789` or `123-456-789`. Used when `country` is `CA` **NOTE: Only applicable for Canadian Payroll (Early Access)** |
| is\_943 | boolean | Set to `true` if the employee is a farmworker |
| is\_scheduleH | boolean | Set to `true` if the employee falls under the Schedule H category as a household employee |
| is\_owner | boolean | Set to `true` if the employee is an Owner of the business and only receives [Owner's Draw](/docs/earning-components#/) earnings or reimbursements. There will be no tax withheld for this type of employee **Note: Early Access** |
| external\_id | string | External ID for an employee that comes from an employer's HR or other internal systems |
| metadata | object | Custom object you can attach to the employee object. This is useful for storing additional information about the object in a custom, structured format. See [Metadata](https://docs.zeal.com/reference/metadata). |
| workLocationID | string | ID of [Work Location Object](/reference-link/company-location-object) |
| work\_week\_start | string | ISO-8601 date-time with accurate UTC offset depicting the beginning of the work week when the employee begins work **NOTE: Only applicable for FLSA Overtime Policy (Early Access)** |
| is\_salary | boolean | Set to `true` if the employee is salaried |
| salary | number | The annual salary amount of the employee |
| is\_regular | boolean | Set to `true` if the employee should be included in “on-cycle” payroll runs |
| everify\_case\_number | string | Case number of the E-Verify request **NOTE: Only applicable for I9/E-Verify (Early Access)** |
| everify\_further\_action\_notice\_url | string | Further action notice URL link of the E-Verify request **NOTE: Only applicable for I9/E-Verify (Early Access)** |
| everify\_status | string | Holds one of the following values:`IN_PROGRESS`: A case has been created for the worker and e-verify is processing it`PENDING_REFERRAL`: The case received a Tentative Nonconfirmation (TNC) status and the employer must tell e-verify how to proceed`REFERRED`: The case has been referred to an E-verify agency and the worker will get in touch with them`SUCCESS`: The worker is authorized to work in the US`FAILURE`: The worker is not authorized to work in the US`FAILURE_NO_SHOW`: The worker never contacted the E-verify agency to resolve their Tentative Nonconfirmation (TNC) after indicating that they would take action, and are not authorized to work in the US`FAILURE_NO_ACTION`: The worker decided to take no action to resolve their Tentative Nonconfirmation (TNC), and are not authorized to work in the US **NOTE: Only applicable for I9/E-Verify (Early Access)** |
| everify\_referral\_date\_confirmation\_url | string | Referral date confirmation URL of the E-Verify request **NOTE: Only applicable for I9/E-Verify (Early Access)** |
| everify\_status\_display | string | Status display of the E-Verify request **NOTE: Only applicable for I9/E-Verify (Early Access)** |
| everify\_ee\_continues\_to\_work\_after\_fnc | boolean | Set to `true` if the employee continues to work after a Final Nonconfirmation **NOTE: Only applicable for I9/E-Verify (Early Access)** |
| everify\_er\_shared\_referral\_date\_confirmation\_at | string | Date the employer shared the referral confirmation of the E-Verify request **NOTE: Only applicable for I9/E-Verify (Early Access)** |
| everify\_status\_updated\_at | string | Status update of the E-Verify request **NOTE: Only applicable for I9/E-Verify (Early Access)** |
| paycard\_requested | boolean | Set to `true`if the contractor has completed paycard enrollment. The paycard may not be successfully provisioned to the contractor yet. **NOTE: Only applicable for Paycards (Early Access)** |
| paycard\_enabled | boolean | Set to `true`if the employee has completed paycard enrollment **NOTE: Only applicable for Paycards (Early Access)** |
| kyc\_status | enum | Holds one of the following values:`null``approved``denied` |
| ssn\_verification\_status | enum | Holds one of the following values:`null``approved``declined` |
| soc\_code | string | The Standard Occupational Classification (SOC) code for the employee, in NN-NNNN format |
| instant\_pay\_enabled | boolean | Set to `true` if the employee has completed instant pay enrollment. **NOTE: Only applicable for Instant Pay (Early Access)** |

<CodeGroup>
  ```bash bash theme={null}
  {
    "employeeID": "1234567890",
    "companyID": "0987654321",
    "onboarded": true,
    "employment_status": "live",
    "term_date": null,
    "first_name": "erlich",
    "last_name": "bachman",
    "email": "erlich@zeal.com",
    "dob": "1999-12-04",
    "start_date": "2019-06-04",
    "title": "Brand Ambassador",
    "working_state": "CA",
    "workLocationID": "6247402f38756100224f0a52",
    "address": "320 Pancake Hollow Road",
    "address_line2": null,
    "city": "Highland",
    "state": "NY",
    "zip": "12528",
    "phone_number": "+18214370987",
    "default_pay_schedule": "weekly",
    "default_wage": 20,
    "default_ot_wage": 30,
    "default_dt_wage": 40,
    "ssn": "123456789",
    "is_943": true,
    "is_scheduleH": false,
    "is_salary": true,
    "salary": 100000,
    "external_id": "123456789",
    "paycard_requested": false,
    "paycard_enabled": false,
    "kyc_status": "approved",
    "ssn_verification_status": null,
    "soc_code": "15-1256",  
  	"instant_pay_enabled": true
  }
  ```
</CodeGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.