The Employment object

Employment objects track the most recent user employment data, such as employer name, manager name, employer address, and other information. The employment data is associated with the link_id from Truv’s Income and Employment product type.

The employments[] array can contain multiple entries. These may represent different employers or multiple positions at the same employer. Multiple positions at the same employer occur when an employee is rehired after an absence — each employment period appears as a separate entry. This is distinct from a promotion or title change, which updates the existing entry rather than creating a new one.When multiple entries exist for the same employer, use original_hire_date to identify the very first hire date at that employer and start_date to identify when the current (or most recent) employment period began. If the employee was never rehired, these two dates are the same.Sandbox testing: Use multiple.employments to test multiple entries from different employers, and multiple.employments2 to test multiple positions at the same employer (rehire scenario).

Attributes

The values in this table cover attributes for the employment endpoints.

Attribute	Type	Description
id	string	Unique ID of selected employee
is_active	boolean	Status of active employment
job_title	string	Job title of employee
job_type	string	Job types of employee: `F` - Full Time, `P` - Part Time, `S` - Seasonal, `D` - Daily, `C` - Contract, `V` - Volunteer
start_date	date	Start of the current employment period. For rehires, this is the date the employee was most recently hired back.
original_hire_date	date	The very first hire date at this employer. Differs from `start_date` when the employee was rehired after a separation.
end_date	date	Employee’s employment end date
income	string	Base income amount, not including commission or bonuses
income_unit	string	Pay interval for income field reference: `YEARLY` - Annual income, `MONTHLY` - Monthly income, `WEEKLY` - Weekly income, `DAILY` - Daily income, `HOURLY` - Hourly income
pay_rate	string	Payment rate per pay cycle
pay_frequency	string	Pay frequency: `M` - Monthly, `SM` - Semi-Monthly, `W` - Weekly, `BW` - Bi-Weekly, `A` - Annually, `SA` - Semiannually, `C` - Commission
external_last_updated	date	Indicates date of last update for employment data from payroll provider
derived_fields	array of strings	Array of derived fields
missing_data_fields	array of strings	List of missing data fields from payroll response
manager_name	string, null	Supervisor name of employee
company	object	Company object

Company object

This table covers values within the company object.

Attribute	Type	Description
name	string	Company name
address	object	Address object
phone	string	Company phone number
ein	string	Employer Identification Number

Address object

The values in this table are for the address object of the company.

Attribute	Type	Description
street	string	Street
city	string	City
state	string	State
zip	string	Zip
country	string	Country

Endpoint

View the available endpoint for employment below.

Retrieve an employment

Example response

The JSON object below is the sample response for the endpoint.

{
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "income": "70000.00",
  "income_unit": "YEARLY",
  "pay_rate": "6500.00",
  "pay_frequency": "M",
  "is_active": false,
  "job_title": "PR associate",
  "job_type": "F",
  "start_date": "2018-01-01",
  "original_hire_date": "2017-06-21",
  "end_date": "2022-12-11",
  "external_last_updated": "2022-12-11",
  "derived_fields": [
    "is_active"
  ],
  "missing_data_fields": [
    "w2s"
  ],
  "manager_name": "Jenny McDouglas",
  "company": {
    "name": "Facebook Demo",
    "address": {
      "street": "1 Morgan Ave",
      "city": "Los Angeles",
      "state": "CA",
      "zip": "90210",
      "country": "US"
    },
    "phone": "6503087300",
    "ein": "12-345678"
  }
}

​Attributes

​Company object

​Address object

​Endpoint

​Example response

Attributes

Company object

Address object

Endpoint

Example response