For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Truework.comAPI StatusGet your API key
HomeGuidesAPI referenceHelp
HomeGuidesAPI referenceHelp
    • Introduction
  • Using the API
    • Authentication
    • Versioning
    • Webhooks
    • Sandbox environment
    • Monitoring
    • Limits
  • Verification orders & reports
    • POSTCreate a target employer order
    • POSTCreate an employer search order
    • POSTCreate a Truework Direct order
    • GETGet one order
    • GETGet all orders
    • PUTCancel an order
    • GETGet one report
    • GETGet order events
    • POSTReverify a report
  • Public beta APIs
  • Previous API versions
    • API version 2022-08-01
    • API version 2020-12-07
    • API version 2019-10-15
LogoLogo
Truework.comAPI StatusGet your API key

Get one report

GET
/reports/:verification_report_id
GET
/reports/:verification_report_id
$curl https://api.truework-sandbox.com/reports/verification_report_id \
>     -H "Authorization: Bearer <token>"
1{
2  "additional_notes": "string",
3  "annotations": {
4    "applicant": {
5      "employee": {
6        "positions": [
7          {
8            "end_date": "2023-01-15",
9            "start_date": "2023-01-15",
10            "title": "Software Engineer"
11          }
12        ],
13        "salary": {
14          "pay_rate": {
15            "amount": "150000.00",
16            "unit": {
17              "canonical_value": {},
18              "raw_value": {}
19            }
20          }
21        },
22        "status": {
23          "canonical_value": "active",
24          "raw_value": "string"
25        },
26        "status_detail": {
27          "canonical_value": "active",
28          "raw_value": "string"
29        }
30      },
31      "employer": {
32        "email": "string",
33        "name": "string",
34        "phone_number": "string"
35      }
36    },
37    "verifier": {
38      "employee": {
39        "positions": [
40          {
41            "end_date": "2023-01-15",
42            "start_date": "2023-01-15",
43            "title": "Software Engineer"
44          }
45        ],
46        "salary": {
47          "pay_rate": {
48            "amount": "150000.00",
49            "unit": {
50              "canonical_value": {},
51              "raw_value": {}
52            }
53          }
54        },
55        "status": {
56          "canonical_value": "active",
57          "raw_value": "string"
58        },
59        "status_detail": {
60          "canonical_value": "active",
61          "raw_value": "string"
62        }
63      },
64      "employer": {
65        "email": "string",
66        "name": "string",
67        "phone_number": "string"
68      }
69    }
70  },
71  "applicant_documents": [
72    {
73      "detections": [
74        {
75          "count": 1,
76          "outcome": {
77            "canonical_value": "passed",
78            "raw_value": "string"
79          },
80          "type": {
81            "canonical_value": "ssn-mismatch",
82            "raw_value": "string"
83          }
84        }
85      ],
86      "id": "AAAAAAAAA3IAF7BGt6e3K0DXcz2pU2ZnvhxOzrfckvfNROXjJN9Rf6oV",
87      "url": "string"
88    }
89  ],
90  "completed": "2021-12-20T18:50:20.291247Z",
91  "completed_by_method": {
92    "canonical_value": "instant",
93    "raw_value": "string"
94  },
95  "created": "2021-12-20T18:50:20.291247Z",
96  "current_as_of": "2021-12-20",
97  "disputes": [
98    {
99      "created": "2021-12-20T18:50:20.291247Z",
100      "description": "Employee Title",
101      "id": "AAAAAAAAAL8AElevkrw2n2vI8ScqGJEf50Lfg4W9LiQXwi-KSmg7DH0P",
102      "reference_id": "d75346a0-a747-4907-a506-639ea436f2b0"
103    }
104  ],
105  "eligibilities": [
106    {
107      "is_eligible": true,
108      "provider": {
109        "canonical_value": "truework",
110        "raw_value": "truework"
111      },
112      "reference_id": "FNM123",
113      "type": {
114        "canonical_value": "d1c",
115        "raw_value": "string"
116      }
117    }
118  ],
119  "employee": {
120    "address": {
121      "address": "1234 Rainbow Road",
122      "city": "San Francisco",
123      "country_code": "US",
124      "country_subdivision_code": "CA",
125      "extended_address": "Suite 300",
126      "postal_code": "98265"
127    },
128    "earnings": [
129      {
130        "base": "35000.00",
131        "bonus": "0.00",
132        "commission": "100.25",
133        "other": "0.00",
134        "overtime": "200.00",
135        "total": "35300.25",
136        "year": "2020"
137      }
138    ],
139    "email": "john.doe@example.com",
140    "first_name": "Jane",
141    "hired_date": "2023-05-15",
142    "last_name": "Doe",
143    "on_leave_date": "2023-08-20",
144    "original_hired_date": "2020-02-16",
145    "positions": [
146      {
147        "employment_type": {
148          "canonical_value": "regular-full-time",
149          "raw_value": "string"
150        },
151        "end_date": "2022-12-31",
152        "start_date": "2022-01-01",
153        "title": "Software Engineer"
154      }
155    ],
156    "salary": {
157      "hours_per_week": "40",
158      "pay_frequency": {
159        "canonical_value": "annually",
160        "raw_value": "string"
161      },
162      "pay_rate": {
163        "amount": "150000.00",
164        "unit": {
165          "canonical_value": "annually",
166          "raw_value": "string"
167        }
168      },
169      "reduced_covid": "yes"
170    },
171    "social_security_number": "***-**-0000",
172    "status": {
173      "canonical_value": "active",
174      "raw_value": "string"
175    },
176    "status_detail": {
177      "canonical_value": "active",
178      "raw_value": "string"
179    },
180    "termination_date": "2024-02-29"
181  },
182  "employer": {
183    "address": {
184      "address": "1234 Rainbow Road",
185      "city": "San Francisco",
186      "country_code": "US",
187      "country_subdivision_code": "CA",
188      "extended_address": "Suite 300",
189      "postal_code": "98265"
190    },
191    "government_ids": [
192      {
193        "id": "123456789",
194        "type": {
195          "canonical_value": "us-fein",
196          "raw_value": "string"
197        }
198      }
199    ],
200    "name": "ACME Inc"
201  },
202  "financial_institution_accounts": [
203    {
204      "account_name": "string",
205      "account_type": "string",
206      "financial_institution_name": "string",
207      "income_streams": [
208        {
209          "age_in_months": 1,
210          "average_monthly_net_income": 1.1,
211          "confidence": 1,
212          "confidence_level": "string",
213          "end_date": "2023-01-15",
214          "estimated_gross_annual": 1.1,
215          "frequency_days": 1,
216          "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31",
217          "name": "string",
218          "net_annual": 1.1,
219          "periods": [
220            {
221              "amount": 1.1,
222              "amount_duration": "string",
223              "amount_type": "string",
224              "estimated_gross_income": {
225                "average_monthly_net_income": 1.1,
226                "estimated_gross_annual": 1.1,
227                "net_annual": 1.1
228              },
229              "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31",
230              "start_day": "2023-01-15"
231            }
232          ],
233          "start_date": "2023-01-15",
234          "status": "string"
235        }
236      ],
237      "number": "string",
238      "oldest_transaction_date": "2023-01-15",
239      "owner_name": "string",
240      "snapshots": [
241        {
242          "available_balance": 1.1,
243          "average_monthly_balance": 1.1,
244          "balance": 1.1,
245          "balance_date": "2023-01-15",
246          "currency_code": "string",
247          "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31",
248          "tot_number_days_since_most_recent_insufficient_funds_fee_debit_tx_account": 1,
249          "tot_number_insufficient_funds_fee_debit_tx_account": 1,
250          "tot_number_insufficient_funds_fee_debit_tx_over_2_months_account": 1
251        }
252      ]
253    }
254  ],
255  "id": "AAAAAAAADU8ACy03lGitY_ocCMCcgproUq8Gt4r37MM6GbyX2-DxWM3Y",
256  "income_analytics": {
257    "annualized_income": {
258      "base_amount": {
259        "amount": "34.95",
260        "currency": "USD"
261      },
262      "gross_amount": {
263        "amount": "34.95",
264        "currency": "USD"
265      },
266      "short_employment_warning": true,
267      "stale_data_warning": true,
268      "variable_income_warning": true
269    },
270    "income_volatility": {
271      "gross_income_volatility": "0.1234"
272    }
273  },
274  "paystubs": [
275    {
276      "base": "7000.00",
277      "bonus": "1000.00",
278      "commission": "0.00",
279      "gross": "8000.00",
280      "id": "AAAAAAAAAmEADp7bmZJNhm4Kr5FM_ty5A_JX-Rxh04GSIHwmIRyp6Xss",
281      "net": "5500.00",
282      "other": "0.00",
283      "overtime": "0.00",
284      "pay_date": "2023-01-15",
285      "pay_period_end_date": "2023-01-15",
286      "pay_period_hours": "86.67",
287      "pay_period_start_date": "2023-01-15",
288      "reference_id": "6894632654"
289    }
290  ],
291  "respondent": {
292    "email": "john.doe@example.com",
293    "full_name": "John Doe",
294    "title": "Software Engineer"
295  },
296  "verification_request": {
297    "created": "2021-12-20T18:50:20.291247Z",
298    "id": "AAAAAAAAEboABwQhKv1_pWO7MWtZs28ksPTH0uSt6GffsoIJPj7e69P1",
299    "type": "employment"
300  }
301}
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>
Was this page helpful?
Previous

Get order events

Next
Built with

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.

Authentication

AuthorizationBearer
Bearer tokens conform to the [RFC6750](https://datatracker.ietf.org/doc/html/rfc6750#section-2.1) spec. Production API keys (secret keys) are prefixed with `tw_sk_` and sandbox keys are prefixed with `tw_sk_test_`. If your secret key is published, you should rotate your API keys. Truework.JS publishable keys are prefixed with `tw_pk_` and `tw_pk_test` respectively. **Examples** - For Authorization Headers: `Authorization: Bearer tw_sk_test_e508eb797edb95ade85284bcb54dd49ed45db1be` - For the "try it now" `token` field, input only the token itself, omitting `Bearer `.

Path parameters

verification_report_idstringRequired
Report ID

Headers

AcceptenumOptionalDefaults to application/json
Specify the content type and version that the API should use. It's recommended to include this to avoid breaking changes.
Allowed values:

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.
fieldsstring or nullOptional

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 headers

Datestring
For JSON requests, the date at which the request was signed
X-Truework-Signaturestring
For JSON requests, the signature of the request, see: https://www.truework.com/docs/verifications-signatures

Response

OK
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
createddatetime
current_as_ofdate
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
idstring1-128 characters
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
verification_requestobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
429
Too Many Requests Error
451
Unavailable for Legal Reasons Error
500
Internal Server Error
501
Not Implemented Error

Bearer tokens conform to the RFC6750 spec.

Production API keys (secret keys) are prefixed with tw_sk_ and sandbox keys are prefixed with tw_sk_test_. If your secret key is published, you should rotate your API keys.

Truework.JS publishable keys are prefixed with tw_pk_ and tw_pk_test respectively.

Examples

  • For Authorization Headers: Authorization: Bearer tw_sk_test_e508eb797edb95ade85284bcb54dd49ed45db1be
  • For the “try it now” token field, input only the token itself, omitting Bearer .

For JSON requests, the signature of the request, see: https://www.truework.com/docs/verifications-signatures