Getting the Report Url

You can obtain the completed income report's URL by hitting this endpoint.

When the screening group is completed, we will produce and host a pdf report. You can get the url to that report by hitting the following endpoint. For security, this returned url expires in 2 hours. We recommend generating this url and redirecting on demand (when the user clicks to view the income report).

If the screening group is still in progress and the report has not been created yet, the response will have a status code of 404 Not Found. If the report has expired, the response will have a status code of 410 Gone.

Get Report PDF URL

GET https://api.payscore.com/api/v1/screening_groups/{id}/report

Path Parameters

Name	Type	Description
id	string	The ID of the screening group

200 The response for a successfully completed income verification report

{
    "url": "https://closing-docs.s3.us-west-2.amazonaws.com/prod/scr..."
}

404 The response if the report has not been created yet

410 The response if the report has expired