Employment history report combines employment, employer, and employee identity information. See links below for more detail. If you want to run an employment history report, visit API reference.

Field Customization

In the Dashboard, you can determine which data fields will be required in the API response. Mandatory fields there will be grayed out and can't be disabled. Example below:

Data Structure

Sample report
Verification Metadata
Employment
Employer
Identity

Sample Report

{
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "status": "new",
  "completed_at": "2021-04-06 11:30:00+00:00",
  "access_token": "48427a36d43c4d5aa6324bc06c692456",
  "tracking_info": "user123456",
  "employments": [
    {
      "id": "24d7e80942ce4ad58a93f70ce4115f5c",
      "job_title": "PR associate",
      "job_type": "F",
      "start_date": "2018-01-01",
      "end_date": "2019-08-24",
      "external_last_updated": "2019-08-24",
      "original_hire_date": "2017-06-21",
      "is_active": false,
      "dates_from_statements": false,
      "derived_fields": [
        "is_active"
      ],
      "missing_data_fields": [
        "w2s"
      ],
      "profile": {
        "first_name": "John",
        "last_name": "Doe",
        "middle_initials": "K",
        "ssn": "123456789",
        "email": "[email protected]",
        "date_of_birth": "1992-03-03",
        "home_address": {
          "street": "1 Morgan Ave",
          "city": "Los Angeles",
          "state": "CA",
          "zip": "90210"
        }
      },
      "company": {
        "name": "Facebook Demo",
        "address": {
          "street": "1 Hacker Way",
          "city": "Menlo Park",
          "state": "CA",
          "zip": "94025"
        },
        "phone": "6503087300"
      }
    }
  ],
  "provider": "adp"
}

Verification data

Data associated with employment and income verification.

Name	Type	Description
id	string	Unique ID of the report
status	string	Task status from the Task Lifecycle
completed_at	string	Timestamp of report completion
access_token	string	access_token for a Link to payroll provider
tracking_info	string	Any string value provided by you when bridge_token was created
refresh_status	string	Status of most recent refresh task
provider	string	Payroll provider which user connected
employments	object	List of employments received from a payroll provider

Employment data

Information about all employments that were found in payroll provider records.

Name	Type	Description
id	string	Unique ID for an employment
job_title	string (nullable)	Employee's job title
job_type	string (nullable)	Type of employment recorded in payroll provider: `F` - Full Time `P` - Part Time `S` - Seasonal `D` - Daily (per diem) `C` - Contract
start_date	string(date)	Date when employment started
end_date	string(date) (nullable)	Date when employment ended
external_last_updated	string(date) (nullable)	Date when employment data was last updated in payroll provider
original_hire_date	string(date) (nullable)	Date when employee was originally hired.
is_active	boolean (nullable)	Indicates whether the employment is still active
dates_from_statements	boolean (nullable)	Indicates whether employee's hire and/or termination dates were derived from first/last pay statements
derived_fields	object (nullable)	Array of derived fields
missing_data_fields	object (nullable)	List of data fields which are missing in the payroll API response
company	object (nullable)	Employer information
profile	object (nullable)	Identity information

Employer data

Information about all employers that were found in payroll provider records.

Name	Type	Description
name	string	Employer name
address	object (nullable)	Employer address
street	string (nullable)	Employer street
city	string (nullable)	Employer city
state	string (nullable)	Employer state
zip	string (nullable)	Employer zip code
phone	string (nullable)	Employer phone number

Identity data

Employee's personal information found in payroll provider.

Name	Type	Description
first_name	string	First name
last_name	string	Last name
middle_initials	string (nullable)	Middle initials
ssn	string (nullable)	Social security number (Full or last 4 digits)
email	string(email) (nullable)	Personal or work email address
date_of_birth	string(date) (nullable)	Date of birth
home_address	object (nullable)	Home address
street	string (nullable)	Street
city	string (nullable)	City
state	string (nullable)	State
zip	string (nullable)	Zip code

Downloadable PDF Report

The report is generated automatically for each successful connection and can be downloaded from the dashboard or via API.