Get one report

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.

<!— theme: 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.

Path parameters

verification_report_idstringRequired
Report ID

Headers

AuthorizationstringRequired

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

Accept"application/json"Required
Specify the content type and version that the API should use. It's recommended to include this to avoid breaking changes.

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

OK
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
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
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

Errors