The employee object

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,
    "payment_method_preference": null,
    "active": true,
    "onboard": {
        "status": "blocking",
        "blocking_steps": [
            "ssn"
        ],
        "remaining_steps": [
            "ssn",
            "payment_method"
            "withholdings",
        ],
        "ssn": [
            "ssn_submitted",
        ],
        "payment_method": [
            "payment_method_preference_set",
            "bank_account_exists",
            "bank_account_verified",
        ],
        "withholdings": [
            {
                "id": "jur_kSO0VneVfdx5TDDQ9Xnp",
                "name": "Federal",  
            },
            {
                "id": "jur_CUlTApePRnDFn9bPVCQE",
                "name": "New York",  
            },  
        ]
    },
    "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": {}
}
AttributeDescription
id
string
Unique identifier for the employee.
first_name
string
Employee's first name.
middle_name
string
Employee's middle name.
last_name
string
Employee's last name.
email
string
Employee's email address.
dob
YYYY-MM-DD
Employee’s date of birth.
bank_accounts
array of strings
Read only. An array of bank account IDs for the employee.
ssn_last_four
string
The last four digits of the employee’s SSN or TIN.
payment_method_preference
string
Either manual or direct_deposit if the employee has a linked bank account.
active
boolean
Indicates whether the employee is currently employed.
onboard
object
Structured information about the onboard status of the employee.
workplaces
array of strings
IDs of workplaces where the employee works.
primary_workplace
string
ID of the employee's primary workplace.
company
string
ID of employee's company.
start_date
YYYY-MM-DD
Most recent start date of employment.
termination_date
YYYY-MM-DD
Most recent date of employment termination. Will be set to null if a more recent start date is set.
default_net_pay_split
string
ID of the net pay split currently active on the employee
residence
object
Employee’s residence.
w2_electronic_consent_provided
boolean
Indicates whether the employee has opted into electronic delivery of W2 PDF.
metadata
object
Additional loosely structured information to associate with the employee.