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.

Path parameters

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

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

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

Response

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

Errors