---
title: "Get Report File"
method: GET
path: "/reports/{reportKey}/file"
tags: ["Retrieve Reports"]
---

# Get Report File

`GET /reports/{reportKey}/file`

## Request

- Base URL: `https://eu-west-1.api.silverflow.com/v1`
- URL: `https://eu-west-1.api.silverflow.com/v1/reports/{reportKey}/file`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/silverflow/apis/silverflow-api/docs/reports/:reportKey/file/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the Report data as a downloadable file. This will return a `307` (redirect) status code, redirecting the request to the location of the file.

To optimize the file download, the contents are `gzip` encoded. The Response contents need to be unzipped.

Not every report is in `application/json` format, thus there aren't response schema's available for every report type.

The file URL the request is redirected to, will remain **available for 1 hour**. After this time, you need to call this endpoint to generate a new URL. Make sure your HTTP client is configured to follow redirects, so you can correctly obtain the file.

Requires one of the following permissions depending on the report:
  - `reports:Download`
  - `reports:DownloadSchemeFeeDetails`
  - `reports:DownloadReconciliationDetails`
  - `reports:DownloadQuarterlySchemeReport`
  - `reports:DownloadNetworkFundsTransfers`
  - `reports:DownloadCharges`
  - `reports:DownloadFraudNotifications`
  - `reports:DownloadDisputeHistoryEvents`

Please check our detailed reporting guide including best practices integration and other considerations [here](https://docs.silverflow.com/guides/reporting).

## Path parameters

- `reportKey` string, required: Uniquely identifies a report object

## Response `204`

The report is not available to download yet

## Other responses

- `307`: Report file
- `400`: Bad Request
- `401`: Unauthorized
- `403`: The authenticated client is forbidden to make the request for the resource identified.
- `404`: Report not found
- `415`: Unsupported mimeType
- `429`: The number of requests (per minute) has exceeded the configured maximum

---

[API](https://skmtc.dev/silverflow/apis/silverflow-api.md) - [All operations](https://skmtc.dev/silverflow/apis/silverflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/silverflow/apis/silverflow-api/revisions/43ecbe4fd6ea?raw)