> For the complete documentation index, see [llms.txt](https://docs.payscore.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payscore.com/payscore-v1-deprecated/reports/getting-the-report-url.md).

# Getting the Report Url

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

<mark style="color:blue;">`GET`</mark> `https://api.payscore.com/api/v1/screening_groups/{id}/report`

#### Path Parameters

| Name | Type   | Description                   |
| ---- | ------ | ----------------------------- |
| id   | string | The ID of the screening group |

{% tabs %}
{% tab title="200 The response for a successfully completed income verification report" %}

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

{% endtab %}

{% tab title="404 The response if the report has not been created yet" %}

```
```

{% endtab %}

{% tab title="410 The response if the report has expired" %}

```
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.payscore.com/payscore-v1-deprecated/reports/getting-the-report-url.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
