AKakahu
Reports

Download all report data as a single JSON file

In order to facilitate fast access to potentially large datasets this endpoint returns a HTTP 302 redirect to the result. You may need to configure your HTTP client to follow redirects in order to access the results transparently.

The final response provides a JSON object containing all of the report data combined. This avoids the need for pagination, but note that the resulting payload may be quite large.

get/v1/applications/{applicationId}/reports/{reportId}/json

Request

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

Path parameters

applicationIdstring required
Example:application_tz4a98xxat96iws9zmbrgj3a
reportIdstring required
Example:report_tz4a98xxat96iws9zmbrgj3a

Response

Success

Example response

{
  "data_sources": [
    {
      "_id": "src_tz4a98xxat96iws9zmbrgj3a",
      "_account": "report_acc_tz4a98xxat96iws9zmbrgj3a",
      "origin": {
        "_document": "doc_tz4a98xxat96iws9zmbrgj3a"
      }
    }
  ],
  "accounts": [
    {
      "_id": "report_acc_tz4a98xxat96iws9zmbrgj3a",
      "periods": [
        {
          "_source": "src_tz4a98xxat96iws9zmbrgj3a"
        }
      ],
      "loan": {
        "purpose": "HOME",
        "interest": {
          "type": "FIXED",
          "rate": 5.7,
          "expires_at": "2026-08-22T12:00:00.000Z"
        },
        "repayment": {
          "structure": "PRINCIPAL_AND_INTEREST",
          "frequency": "FORTNIGHTLY",
          "next_amount": 2061,
          "next_date": "2026-07-04T12:00:00.000Z"
        },
        "term": {
          "years": 29,
          "months": 6
        },
        "initial_principal": 500000,
        "matures_at": "2048-08-22T12:00:00.000Z"
      }
    }
  ],
  "insights": [
    {
      "code": "insight:000/useful-name-here",
      "scope": {
        "identifier": "report_tz4a98xxat96iws9zmbrgj3a"
      }
    }
  ],
  "transactions": [
    {
      "_id": "report_trans_tz4a98xxat96iws9zmbrgj3a",
      "_account": "report_acc_tz4a98xxat96iws9zmbrgj3a",
      "merchant": {
        "_id": "merchant_cjtt1msoq000a59oj3tpw7vla",
        "name": "Woolworths",
        "logo": "https://cdn.akahu.nz/logos/merchants/merchant_cjtt1msoq000a59oj3tpw7vla"
      },
      "nzfcc": {
        "_id": "nzfcc_ckouvvy84001608ml5p6z4d8j",
        "name": "Supermarkets and grocery stores"
      },
      "income_category": {
        "code": "income:000/useful-name-here"
      },
      "spending_category": {
        "code": "spending:000/useful-name-here"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.