AKakahu
Reports

Get report accounts

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

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

Request

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

Path parameters

applicationIdstring required
Example:application_tz4a98xxat96iws9zmbrgj3a
reportIdstring required
Example:report_tz4a98xxat96iws9zmbrgj3a

Query parameters

cursorstring

Response

Success

cursorstring nullable required

Example response

{
  "items": [
    {
      "_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"
      }
    }
  ]
}

Changes

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