id

string

Unique ID of the report

status

string

Task status from Connection Lifecycle

completed_at

string

Timestamp of completed report

finished_at

string

Time when report was finished

access_token

string

access_token for a Link to payroll provider

tracking_info

string

Provided string value when bridge_token was created

is_suspicious

boolean

Flag to indicate if the data from the source is suspicious. For example: Fraud detected in uploaded documents or SSN of the user does not match with the data

provider

string

User connected payroll provider

data_source

string

Source of data
payroll - Payroll provider aggregation
docs - User-uploaded documents
financial_accounts - Financial account aggregation

pdf_report

uri

Employer verification report in PDF format

refresh_status

string

Status of most recent refresh task

employments

array of objects

List of employer data, see Employments

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 of last update from payroll provider for employment data

original_hire_date

string(date)
(nullable)

Date when employee was originally hired

is_active

boolean
(nullable)

Status of active employment

dates_from_statements

boolean
(nullable)

Status of employee's hire and termination dates from first and last pay statements (Deprecated)

derived_fields

object
(nullable)

Array of derived fields

missing_data_fields

object
(nullable)

List of missing data fields in the payroll API response

income

string(decimal)
(nullable)

Income amount not including commission or bonuses. The annual amount will be displayed for salaried individuals.

income_unit

string
(nullable)

Pay interval for income:
YEARLY - Annual
MONTHLY - Monthly
WEEKLY - Weekly
DAILY - Daily
HOURLY - Hourly

pay_frequency

string
(nullable)

Pay frequency:
M - Monthly
SM - Semi-Monthly
BW - Bi-Weekly
W - Weekly

pay_rate

string(decimal)
(nullable)

Amount paid per pay cycle for salaried individuals. For hourly workers, refer to the income and income_unit fields for the corresponding pay information.

manager_name

string
(nullable)

Direct supervisor's name

company

object
(nullable)

Employer information

profile

object
(nullable)

Identity information

annual_income_summary

object
(nullable)

Annual income summary from last pay stub of the year

statements

object
(nullable)

List of paystubs found in the payroll account

w2s

object
(nullable)

List of W-2 forms found in the payroll account

bank_accounts

object
(nullable)

List of bank accounts linked to the payroll account and allocations for direct deposit

gse_accepted

Boolean

Status of provider eligibility from Fannie Mae Desktop Underwriter (only applies to VOIE Report for a User)

name

string

Employer name

address

object

Employer address.

phone

string
(nullable)

Employer phone number

ein

string
(nullable)

Employer Identification Number

id

string

ID of the object

created_at

string

Person's identity info was retrieved first time (ISO 8601)

updated_at

string

Person's identity info was retrieved last time (ISO 8601)

first_name

string

First name

last_name

string

Last name

full_name

string

Full 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

Home address

id

string

Unique ID

year

integer

Year

regular

string(decimal)
(nullable)

Regular salary

bonus

string(decimal)
(nullable)

Bonuses

commission

string(decimal)
(nullable)

Commissions

overtime

string(decimal)
(nullable)

Overtime

other_pay

string(decimal)
(nullable)

All other type of income

gross_pay

string(decimal)
(nullable)

Gross income

net_pay

string(decimal)
(nullable)

Net income

id

string

Unique ID

check_number

string
(nullable)

External ID of pay stub from payroll provider

pay_date

string(date)

Pay Date

period_start

string(date)
(nullable)

Period start

period_end

string(date)
(nullable)

Period end

basis_of_pay

string
(nullable)

Basis of pay:
S - Salary
H - Hourly
D - Daily
W - Weekly

hours

string
(nullable)

Number of hours worked this pay period

gross_pay

string(decimal)
(nullable)

Gross pay

gross_pay_ytd

string(decimal)
(nullable)

Gross pay year to date

net_pay

string(decimal)
(nullable)

Net pay

net_pay_ytd

string(decimal)
(nullable)

Net pay year to date

regular

string(decimal)
(nullable)

Regular pay

regular_ytd

string(decimal)
(nullable)

Regular pay year to date

bonus

string(decimal)
(nullable)

Bonuses

bonus_ytd

string(decimal)
(nullable)

Bonuses year to date

commission

string(decimal)
(nullable)

Commissions

commission_ytd

string(decimal)
(nullable)

Commission year to date

overtime

string(decimal)
(nullable)

Overtime pay

overtime_ytd

string(decimal)
(nullable)

Overtime pay year to date

other_pay

string(decimal)
(nullable)

Sum of all other types of income

other_pay_ytd

string(decimal)
(nullable)

Year to date sum of all other types of income

earnings

object
(nullable)

Earnings for this pay cycle by type

earnings_ytd

string (nullable)

Earnings year to date by type

     name

string (nullable)

Earnings name

     amount

string (nullable)

Earnings amount value

     category

string (nullable)

Title of category
Supported categories: regular, bonus, commission, overtime, other_pay

     rate

string (nullable)

Pay rate for a specified earnings name

     units

string (nullable)

Number of hours worked for a specified earnings name

deductions

object
(nullable)

Deductions for this pay cycle by type

deductions_ytd

object
(nullable)

Deductions year to date by type

     amount

string (decimal)
(nullable)

Deductions amount value

     category

string (nullable)

Title of category
Supported categories: memo, medicare, retirement, socialsec, federal, state, garnishment, local, other

     name

string (nullable)

Deductions name

md5sum

string(string)
(nullable)

Computed MD5 hash value from file content

file

string(uri)
(nullable)

Content-type format specified link to pay stub file

derived_fields

object
(nullable)

Array of derived fields

missing_data_fields

object
(nullable)

List of missing data fields in the payroll API response

name

string (nullable)

Earnings name

amount

string (decimal)
(nullable)

Earnings amount value

category

string (nullable)

Title of category
Supported categories: regular, bonus, commission, overtime, other_pay

rate

string (nullable)

Pay rate for a specified earnings name

units

string (nullable)

Number of hours worked for a specified earnings name

amount

string (decimal)
(nullable)

Deductions amount value

category

string (nullable)

Title of category
Supported categories: memo, medicare, retirement, socialsec, federal, state, garnishment, local, other

name

string (nullable)

Deductions name

account_number

string

Account number

routing_number

string
(nullable)

Routing number

account_name

string
(nullable)

User friendly account name

bank_name

string
(nullable)

Bank name

account_type

string
(nullable)

Account type:
C - Checking account
S - Savings account

deposit_type

string
(nullable)

Deposit type:
E - Entire paycheck
P - Percentage of the paycheck
A - Fixed amount from the paycheck

deposit_value

string(decimal)
(nullable)

Deposit value