Get a Verification Report

GET /verification-requests/<id>/report/

Retrieves a Report for a given Verification id.

info

Only completed Verifications have Reports associated with them. Any other request will fail with either 400 or 404, and provide more information as an attached error message.

Request

URL Parameters

PARAMETERTYPEDESCRIPTION
idstringid of the Verification

Query Parameters

PARAMETERTYPEREQUIREDDESCRIPTION
fieldsstringFields to include in the response. If ommitted, all fields are included

Response

PROPERTYTYPENULLABLEDESCRIPTION
createdstringDatetime at which the report was created in ISO 8601 format
current_as_ofstringDatetime at which the report is up to date in ISO 8601 format
verification_requestAbbreviatedVerificationAn abbreviated version of the associated Verification
employerEmployerInformation about the employer of the employee that is being verified
employeeEmployeeInformation about the employee that is being verified
additional_notesstringFree form text with additional notes on the verification
respondentRespondentInformation on the respondent for the verification
du_reference_idstringThis is the reference id to submit to Fannie Mae for purposes of getting Day 1 Certainty

AbbreviatedVerification

PROPERTYTYPENULLABLEDESCRIPTION
typestringType of the verification request
createdstringDate at which the verification request was created. Returned in ISO 8601 format
idstringid of the verification request

Employer

PROPERTYTYPENULLABLEDESCRIPTION
namestringName of the employer
addressAddressAddress of the employer

Address

PROPERTYTYPENULLABLEDESCRIPTION
line_onestringFirst address line (for example street address)
line_twostringSecond address line
citystringCity
statestringState
countrystringCountry
postal_codestringPostal Code

Employee

PROPERTYTYPENULLABLEDESCRIPTION
first_namestringFirst name of employee
last_namestringLast name of employee
addressAddressAddress of employee
statusStatusCurrent employment status of the employee
status_detailStatusDetailCurrent detailed employment status of the employee
hired_datestringDate at which employee started work at this employer in ISO 8601 format
termination_datestringDate at which employee stopped work at this employer in ISO 8601 format
termination_reasonstringReason for termination from employer
on_leave_datestringDate at which the employee began their leave of absence
social_security_numberstringA redacted representation of the employee's social security number in **--XXXX format
positionsarray of PositionList of positions held by employee at this employer
earningsarray of EarningsList of earnings found for employee at this employer
salarySalaryCurrent salary of employee at this employer
note

Earnings and Salary are only returned for verifications that are of Type employment-income.

Status

There are five employment statuses available on the status field in Employee:

VALUEDESCRIPTIONVERSION INTRODUCEDOLDER VERSION VALUE
activeThe employee is currently employed and working for this employer
inactiveThe employee is not employed at this employer anymore
unknownTruework could not determine the employment status of this employee
furloughed-covidThe employee was furloghed due to COVID-192020-12-07inactive
non-employeeTruework could not find record of this employee2020-12-07unknown

StatusDetail

VALUEDESCRIPTIONStatus
activeThe employee is currently employed and working for this employeractive
int-assignmentThe employee is on international assignmentactive
casualThe employee is employed casuallyactive
long-term-disThe employee is on long term disabilityactive
sick-leaveThe employee is on sick leaveactive
surviving-spouseThe employee is a surviving spouseinactive
inactiveThe employee is not employed at this employer anymoreinactive
on-leaveThe employee is on leaveactive
multiple-positionsThe employee has multiple active positionsactive
new-employeeThe employee is newactive
lay-offThe employee was layed offinactive
part-timeThe employee is currently employed on a part time basisactive
retiredThe employee is retiredinactive
separatedThe employee is separatedinactive
seasonThe employee is seasonalactive
temporaryThe employee is temporaryactive
internThe employee is an internactive
transferredThe employee has been transferredactive
deceasedThe employee is deceasedinactive
severed-payThe employee has been severed with payinactive
on-sabbaticalThe employee is on sabbaticalactive
divestedThe employee is part of a divested populationactive
temp-inactiveThe employee is temporarily inactiveinactive
full-timeThe employee is full timeactive
non-emp-benThe employee is a non employee beneficiaryinactive
not-assignmentThe employee is not currently on assignmentinactive
not-payrollThe employee is not currently on payrollinactive
active-as-neededThe employee is active as neededactive
unknownTruework could not determine the employment status of this employeeunknown
forloughed-covidThe employee was furloghed due to COVID-19forloughed-covid
non-employeeTruework could not find record of this employeenon-employee

Earnings

PROPERTYTYPENULLABLEDESCRIPTION
yearstringThe year in which the earnings were earned
basestringThe amount of base pay earned by employee. Returned in money format formatted as a string
overtimestringThe amount of overtime earned by employee. Returned in money format formatted as a string
commissionstringThe amount of commission earned by employee. Returned in money format formatted as a string
bonusstringThe amount of bonus earned by employee. Returned in money format formatted as a string
totalstringThe total amount of pay earned by employee. Returned in money format formatted as a string

Position

PROPERTYTYPENULLABLEDESCRIPTION
titlestringTitle of the employee for this position at employer
start_datestringDate at which employee started work in this position in ISO 8601 format
employment_typeEmploymentTypeType of employment

EmploymentType

VALUEDESCRIPTIONVERSION INTRODUCEDOLDER VERSION VALUE
regular-full-timeRegular full time
regular-part-timeRegular part time
contractorContractor
otherOther or unknown employement type
no-answerQuestion was not answered2020-12-07other

Salary

PROPERTYTYPENULLABLEDESCRIPTION
gross_paystringAmount paid to employee in gross pay
pay_frequencystringTime interval across which the employee is paid gross_pay
hours_per_weekstringNumber of hours worked per week in string format
months_per_yearstringNumber of months worked per year in string format
reduced_covidReducedPayDueToCovidDescribes if pay was reduced due to COVID-19

ReducedPayDueToCovid

VALUEDESCRIPTION
yesPay was reduced due to covid
noPay was not reduced due to covid
unknownInformation is not known

Respondent

PROPERTYTYPENULLABLEDESCRIPTION
full_namestringFull name of the respondent
titlestringTitle of the respondent

Examples

$ curl "https://api.truework.com/verification-requests/AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP/report/" \
-X GET \
-H 'Authorization: Bearer myTrueworkToken'
{
"created": "2008-09-15T15:53:00Z",
"current_as_of": "2008-09-15T15:53:00Z",
"verification_request": {
"id": "AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP",
"type": "employment-income",
"created": "2008-09-14T9:00:00Z"
},
"employer": {
"name": "Truework Inc",
"address": {
"line_one": "15 Lucerne Street",
"line_two": "Apt 2",
"city": "San Francisco",
"state": "CA",
"country": "US",
"postal_code": "94115"
}
},
"employee": {
"first_name": "First",
"last_name": "Last",
"status": "inactive",
"hired_date": "2017-08-08",
"end_of_employment": "2019-08-08",
"social_security_number": "***-**-9999",
"earnings": [
{
"year": "2019",
"base": "35000.00",
"overtime": "200.00",
"commission": "100.25",
"bonus": "500.00",
"total": "35800.25"
},
{
"year": "2018",
"base": "30000.00",
"overtime": "200.00",
"commission": "100.25",
"bonus": "500.00",
"total": "30800.25"
},
{
"year": "2017",
"base": "30000.00",
"overtime": "200.00",
"commission": "100.25",
"bonus": "500.00",
"total": "30800.25"
}
],
"positions": [
{
"title": "current title",
"start_date": "2018-08-08",
"employment_type": "regular-full-time"
},
{
"title": "past title",
"start_date": "2017-08-08",
"end_date": "2019-08-08",
"employment_type": "regular-part-time"
}
],
"salary": {
"gross_pay": "30000.00",
"pay_frequency": "annually",
"hours_per_week": "40"
}
},
"additional_notes": "some free form text",
"respondent": {
"full_name": "John Doe",
"title": "HR Specialist"
}
}
$ curl "https://api.truework.com/verification-requests/AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP/report?fields=employer,employee(first_name,last_name)/" \
-X GET \
-H 'Authorization: Bearer myTrueworkToken'
{
"employer": {
"name": "Truework Inc",
"address": {
"line_one": "15 Lucerne Street",
"line_two": "Apt 2",
"city": "San Francisco",
"state": "CA",
"country": "US",
"postal_code": "94115"
}
},
"employee": {
"first_name": "First",
"last_name": "Last",
}
}