Get one report

GET

/reports/:verification_report_id

GET

/reports/:verification_report_id

1 import requests
2 
3 url = "https://api.truework-sandbox.com/reports/AAAAAAAAAKsAAYJIcQvm1nwU0xBbfC1Yh4qyqjvLhwt1B9gRmTCHCyW6"
4 
5 querystring = {"include_income_analytics":"true","include_report_annotations":"true","fields":"id,status,employee(positions(start_date),social_security_number)"}
6 
7 headers = {
8     "Accept": "application/json",
9     "Authorization": "Bearer <token>"
10 }
11 
12 response = requests.get(url, headers=headers, params=querystring)
13 
14 print(response.json())

Try it

1 {
2   "created": "2021-12-20T18:50:20Z",
3   "current_as_of": "2021-12-20",
4   "id": "AAAAAAAADU8ACy03lGitY_ocCMCcgproUq8Gt4r37MM6GbyX2-DxWM3Y",
5   "verification_request": {
6     "created": "2021-12-20T18:50:20Z",
7     "id": "AAAAAAAAEboABwQhKv1_pWO7MWtZs28ksPTH0uSt6GffsoIJPj7e69P1",
8     "type": "employment-income"
9   },
10   "additional_notes": "additional_notes",
11   "applicant_documents": [
12     {
13       "detections": [
14         {
15           "count": 1,
16           "outcome": {
17             "canonical_value": "passed",
18             "raw_value": "raw_value"
19           },
20           "type": {
21             "canonical_value": "ssn-mismatch",
22             "raw_value": "raw_value"
23           }
24         }
25       ],
26       "id": "AAAAAAAAA3IAF7BGt6e3K0DXcz2pU2ZnvhxOzrfckvfNROXjJN9Rf6oV",
27       "url": "url"
28     }
29   ],
30   "completed": "2021-12-20T18:50:20Z",
31   "completed_by_method": {
32     "canonical_value": "instant",
33     "raw_value": "raw_value"
34   },
35   "disputes": [
36     {
37       "created": "2021-12-20T18:50:20Z",
38       "id": "AAAAAAAAAL8AElevkrw2n2vI8ScqGJEf50Lfg4W9LiQXwi-KSmg7DH0P",
39       "description": "Employee Title",
40       "reference_id": "d75346a0-a747-4907-a506-639ea436f2b0"
41     }
42   ],
43   "eligibilities": [
44     {
45       "provider": {
46         "canonical_value": "truework",
47         "raw_value": "raw_value"
48       },
49       "is_eligible": true,
50       "reference_id": "FNM123",
51       "type": {
52         "canonical_value": "d1c",
53         "raw_value": "raw_value"
54       }
55     }
56   ],
57   "employee": {
58     "address": {
59       "address": "1234 Rainbow Road",
60       "city": "San Francisco",
61       "country_code": "US",
62       "country_subdivision_code": "CA",
63       "extended_address": "Suite 300",
64       "postal_code": "98265"
65     },
66     "earnings": [
67       {
68         "base": "35000.00",
69         "bonus": "0.00",
70         "commission": "100.25",
71         "other": "0.00",
72         "overtime": "200.00",
73         "total": "35300.25",
74         "year": "2020"
75       }
76     ],
77     "email": "john.doe@example.com",
78     "first_name": "Jane",
79     "hired_date": "2023-05-15",
80     "last_name": "Doe",
81     "on_leave_date": "2023-08-20",
82     "original_hired_date": "2020-02-16",
83     "positions": [
84       {
85         "end_date": "2022-12-31",
86         "start_date": "2022-01-01",
87         "title": "Software Engineer"
88       }
89     ],
90     "salary": {
91       "reduced_covid": "yes",
92       "hours_per_week": "40",
93       "pay_frequency": {
94         "canonical_value": "annually",
95         "raw_value": "raw_value"
96       },
97       "pay_rate": {
98         "amount": "150000.00"
99       }
100     },
101     "social_security_number": "***-**-0000",
102     "status": {
103       "canonical_value": "active",
104       "raw_value": "raw_value"
105     },
106     "status_detail": {
107       "canonical_value": "active",
108       "raw_value": "raw_value"
109     },
110     "termination_date": "2024-02-29"
111   },
112   "employer": {
113     "address": {
114       "address": "1234 Rainbow Road",
115       "city": "San Francisco",
116       "country_code": "US",
117       "country_subdivision_code": "CA",
118       "extended_address": "Suite 300",
119       "postal_code": "98265"
120     },
121     "government_ids": [
122       {
123         "id": "123456789",
124         "type": {
125           "canonical_value": "us-fein",
126           "raw_value": "raw_value"
127         }
128       }
129     ],
130     "name": "ACME Inc"
131   },
132   "financial_institution_accounts": [
133     {
134       "income_streams": [
135         {
136           "confidence": 1,
137           "confidence_level": "confidence_level",
138           "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31",
139           "name": "name",
140           "periods": [
141             {
142               "amount_duration": "amount_duration",
143               "amount_type": "amount_type",
144               "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31",
145               "start_day": "start_day"
146             }
147           ],
148           "status": "status"
149         }
150       ],
151       "snapshots": [
152         {
153           "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31"
154         }
155       ],
156       "account_name": "account_name",
157       "account_type": "account_type",
158       "financial_institution_name": "financial_institution_name",
159       "number": "number",
160       "oldest_transaction_date": "oldest_transaction_date",
161       "owner_name": "owner_name"
162     }
163   ],
164   "income_analytics": {
165     "annualized_income": {
166       "short_employment_warning": true,
167       "stale_data_warning": true,
168       "variable_income_warning": true,
169       "base_amount": {
170         "amount": "34.95"
171       },
172       "gross_amount": {
173         "amount": "34.95"
174       }
175     },
176     "income_volatility": {
177       "gross_income_volatility": "0.1234"
178     }
179   },
180   "paystubs": [
181     {
182       "id": "AAAAAAAAAmEADp7bmZJNhm4Kr5FM_ty5A_JX-Rxh04GSIHwmIRyp6Xss",
183       "base": "7000.00",
184       "bonus": "1000.00",
185       "commission": "0.00",
186       "gross": "8000.00",
187       "net": "5500.00",
188       "other": "0.00",
189       "overtime": "0.00",
190       "pay_date": "pay_date",
191       "pay_period_end_date": "pay_period_end_date",
192       "pay_period_hours": "86.67",
193       "pay_period_start_date": "pay_period_start_date",
194       "reference_id": "6894632654"
195     }
196   ],
197   "respondent": {
198     "email": "john.doe@example.com",
199     "full_name": "John Doe",
200     "title": "Software Engineer"
201   }
202 }

Retrieves a report for a given report ID. If you don’t have the report id, it is recommended to use the embedded reports key on a completed verification object returned from GET /orders. You can get the report in PDF format by adding Accept: application/pdf to your headers. When testing, please use the generated curl command with --output <PDF filename> specified.

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

Retrieves a report for a given report ID. If you don't have the report id, it is recommended to use the embedded reports key on a completed verification object returned from `GET /orders`. You can get the report in PDF format by adding `Accept: application/pdf` to your headers. When testing, please use the generated curl command with `--output <PDF filename>` specified. <Info> Only completed Reports will be returned. Any other request will fail with either 400 or 404, and provide more information as an attached error message. </Info>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

verification_report_idstringRequired

Report ID

Query parameters

include_income_analyticsbooleanOptionalDefaults to false

Whether to calculate income analytics for the nested reports in each verification.

include_report_annotationsbooleanOptionalDefaults to false

Whether to include annotations for the nested reports in each verification.

fieldsstringOptional

Comma-separated names of fields to include in the response. Separate multiple fields with commas, and denote subfields with parentheses. Multiple subfields from the same type can be listed within parentheses. In case of a list, subfields apply to each individual object. If omitted, all fields are included.

Response

createddatetime

current_as_ofstringformat: "date"

idstring>=1 character<=128 characters

verification_requestobject

additional_notesstring or null>=0 characters

annotationsobject or null

Consumer-stated information related to this report

applicant_documentslist of objects or null

completeddatetime or null

The date and time when the verification was completed

completed_by_methodobject or null

disputeslist of objects or null

Disputes that are currently open and relevant to this report

eligibilitieslist of objects or null

Eligibilities for this report

employeeobject or null

employerobject or null

financial_institution_accountslist of objects or null

income_analyticsobject or null

Calculated income features. Only returned if the income_analytics query parameter is provided and is true and the employee status on the report is active.

paystubslist of objects or null

Individual paystubs for each pay period. Paystubs are returned sorted in descending order from most recent to least recent pay date.

respondentobject or null