---
title: "Get report data sources"
method: GET
path: "/v1/applications/{applicationId}/reports/{reportId}/data-sources"
tags: ["Reports"]
---

# Get report data sources

`GET /v1/applications/{applicationId}/reports/{reportId}/data-sources`

## Request

- Base URL: `https://api.apply.akahu.nz`
- URL: `https://api.apply.akahu.nz/v1/applications/{applicationId}/reports/{reportId}/data-sources`
- Auth: HTTP bearer

A data source represents a single financial statement. Note that in the case of multiple statements merged into a single file, there may be multiple data sources pointing to a single document.

**Note**: This endpoint is paginated. To list all data source records, it may be necessary to loop through all available pages using the `cursor` returned with each response.

## Path parameters

- `applicationId` string, required
- `reportId` string, required

## Query parameters

- `cursor` string

## Response `200`

Success

- object
  - `items` ReportDataSource[], required
    - `_id` string, required
    - `_account` string, nullable, required
    - `provider` object, nullable, required: The institution that provides data (eg. a bank, a card issuer).
      - `_id` string, required
      - `name` string, required
      - `logo` string, required: A URL pointing to a logo for this provider.
    - `origin` union, required: The origin of this data source.
      - DocumentCompleteSource: A data source that represents one full document.
        - `type` 'document_complete', required
        - `_document` string
        - `filename` string, required
        - `page_count` number, required
        - `unreadable` boolean
      - DocumentPartialSource: A data source that represents a range of pages within a document.
        - `type` 'document_partial', required
        - `_document` string
        - `filename` string, required
        - `page_start` number, required
        - `page_end` number, required
      - DatafileSource: A data source that represents data from an uploaded Datafile.
        - `type` 'datafile', required
        - `_data_file` string, required
        - `filename` string, required
    - `status` 'unprocessed' | 'processed' | 'duplicate', required: The status of this data source: - `processed`: This data source was successfully processed. - `unprocessed`: This data source was unable to be processed. - `duplicate`: This data source was processed, but it was identified as a duplicate.
    - `period` Period, required
      - `start` string, date-time, required
      - `end` string, date-time, required
  - `cursor` string, nullable, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/akahu/apis/akahu-apply-api.md) - [All operations](https://skmtc.dev/akahu/apis/akahu-apply-api/llms.txt) - [OpenAPI document](https://skmtc.dev/akahu/apis/akahu-apply-api/revisions/3f18eb1ead75?raw)