Skip to navigation
Previous API versionsAPI version 2022-08-01

Get One Report

Deprecated

Retrieves a Report for a given Verification id with multiple reports. If you don’t have the report id, it is recommended to use the embedded reports key from GET /verification-requests/{verification_id} to retrieve reports.

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.

<!— theme: 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. Reports are also embedded into the Verification object returned from get and get one.

Authentication

AuthorizationBearer

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 .

Path parameters

verification_request_idstringRequired
Verification ID
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

income_analyticsbooleanOptionalDefaults to false
Whether to calculate income analytics for the nested reports in each verification.
fieldsstring or nullOptional

Comma-separated names of fields to include in the response. If omitted, all fields are included

Response headers

DatestringOptional
For JSON requests, the date at which the request was signed
X-Truework-SignaturestringOptional

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

Response

OK
additional_notesstring or null>=0 characters
createddatetime
current_as_ofdate
d1c_eligibleboolean or null
Returns true if this report is eligible for Day 1 Certainty
disputeslist of objects
Disputes that are currently open and relevant to this report
du_reference_idstring or null
This is the reference ID to submit to Fannie Mae for purposes of getting Day 1 Certainty
employeeobject
employerobject
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.

paid_through_datedate or null

The pay period end date of the most recent paystub (falling back to the pay date if no pay period end is set). This field is only populated for VOIE reports and will be null for non-VOIE reports or when no paystubs exist.

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.
pricing_tierenum or null
Allowed values:
respondentobject or null
verification_requestobject

Errors

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