Represents a person who receives compensation for a job performed at a company.
{
"id": "emp_zGGp6wYcxAeu1Ng8IA7v",
"first_name": "Tony",
"last_name": "Stark",
"middle_name": null,
"email": "[email protected]",
"dob": "1970-05-29",
"bank_accounts": [],
"ssn_last_four": null,
"ssn_validation_status": null,
"payment_method_preference": null,
"active": true,
"onboard": {
"status": "needs_attention",
"blocking_steps": [],
"remaining_steps": [
"ssn",
"payment_method",
"withholdings",
],
"ssn": [
"ssn_submitted",
"ssn_validated",
],
"payment_method": [
"payment_method_preference_set",
"bank_account_exists",
"bank_account_verified",
],
"withholdings": [
{
"id": "jur_kSO0VneVfdx5TDDQ9Xnp",
"name": "Federal",
"status": "needs_attention",
},
{
"id": "jur_CUlTApePRnDFn9bPVCQE",
"name": "New York",
"status": "needs_attention",
},
]
},
"workplaces": [
"wrk_i8nfu8234r8dkjhzlsdv"
],
"primary_workplace": "wrk_i8nfu8234r8dkjhzlsdv",
"company": "com_sx3svU6K8c5ZkSFlOh5p",
"start_date": "2019-03-01",
"termination_date": null,
"default_net_pay_split": "nps_lk218jk9082mjkjljT1c",
"residence": {
"line1": "630 Bedford Road",
"line2": null,
"city": "Tarrytown",
"state": "NY",
"postal_code": "10591",
"country": "US"
},
"w2_electronic_consent_provided": false,
"metadata": {}
}| Attribute | Description |
|---|---|
idstring | Unique identifier for the employee. |
first_namestring | Employee's first name. |
middle_namestring | Employee's middle name. |
last_namestring | Employee's last name. |
emailstring | Employee's email address. |
dobYYYY-MM-DD | Employee’s date of birth. |
bank_accountsarray of strings | Read only. An array of bank account IDs for the employee. |
ssn_last_fourstring | The last four digits of the employee’s SSN or TIN. |
ssn_validation_statusstring | The validation status of the employee's SSN. Either pending indicating validation in progress, validated indicating the SSN passes our validation criteria, or invalid indicating the SSN is not valid. For more details see SSN Validation . |
payment_method_preferencestring | Either manual or direct_deposit if the employee has a linked bank account. |
activeboolean | Indicates whether the employee is currently employed. Used only for filtering: active decides whether an employee is returned by the active filter on List employees and whether they appear in Console lists, not whether they can be paid. active and termination_date are set independently, so setting termination_date does not require setting active to false. To pay an employee after their last day, see Off-cycle Payrolls. |
onboardobject | Structured information about the onboard status of the employee. |
workplacesarray of strings | IDs of workplaces where the employee works. |
primary_workplacestring | ID of the employee's primary workplace. |
companystring | ID of employee's company. |
start_dateYYYY-MM-DD | Most recent start date of employment. |
termination_dateYYYY-MM-DD | Most recent date of employment termination. Will be set to null if a more recent start date is set. |
default_net_pay_splitstring | ID of the net pay split currently active on the employee |
residenceobject | Employee’s residence. |
w2_electronic_consent_providedboolean | Indicates whether the employee has opted into electronic delivery of W2 PDF. |
metadataobject | Additional loosely structured information to associate with the employee. |

