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

# Get report details

`GET /v1/applications/{applicationId}/reports/{reportId}`

## Request

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

## Path parameters

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

## Response `200`

Success

- Report: Once your Application has been populated with the required data Resources, a Report can be created. A Report combines the data from all Application Resources into an aggregate, enriched dataset.
  - `_id` string, required
  - `report_type` 'standard' | 'income', required: The type of report generated for an application: - `standard` A full report covering accounts, income, expenses and transactions. - `income` A report focused on income.
  - `status` 'processing' | 'completed' | 'failed', required: The status of a report: - `processing` This report is currently being synthesized. - `completed` This report has successfully been synthesized and data can now be retrieved from it. - `failed` This report has failed to be synthesized. See `failure_reason` for more information.
  - `pdf_status` 'processing' | 'completed' | 'failed': The PDF generation status. Absent until generation starts; `completed` when ready to download.
  - `failure_reason` ReportFailureReason: If a report has failed to be synthesized, this field provides additional information about what went wrong.
    - `code` 'internal_error' | 'timeout', required
    - `message` string
  - `resources` ReportResource[], required: The resources that were used to generate this report.
    - union
      - ReportResourceDocument
        - `type` 'document', required
        - `_id` string, required
      - ReportResourceDatafile
        - `type` 'datafile', required
        - `_id` string, required
      - ReportResourceOneoffOpenBankingConnection
        - `type` 'oneoff_ob_connection', required
        - `_id` string, required
  - `generated_at` string, date-time: The date that this report completed synthesis.
  - `expires_at` string, date-time, required: The date that this report expires. After this date the report will no longer be accessible.
  - `spending_categories` SpendingCategory[]: When this report is `completed`, this field will hold a list of all spending categories used in this report.
    - `code` string, required: A unique code for this spending category.
    - `name` string, required: The name of this spending category.
  - `income_categories` IncomeCategory[]: When this report is `completed`, this field will hold a list of all income categories used in this report.
    - `code` string, required: A unique code for this income category.
    - `name` string, required: The name of this income category.
  - `insights` InsightCategoryCode[]: When this report is `completed`, this field will hold a list of all insights used in this report.

## 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)