---
title: "Get Result Status"
method: GET
path: "/status/{code}"
tags: ["Status"]
---

# Get Result Status

`GET /status/{code}`

Get the current status of the one-off data retrieval process.

Your application should poll this endpoint to check the status of the result processing before fetching data from other endpoints. Use the `available_results` flags to know when each type of result is available for your application to fetch.

Once the returned `status` becomes `COMPLETE` or `ERROR`, the result will no longer be updated and your application can stop polling.

## Path parameters

- `code` string, required

## Headers

- `Content-Type` string

## Response `200`

Successful response.

- object
  - `success` boolean
  - `items` Status[]
    - `connection` object, required — Information about institution that the user connected their accounts from (eg. ANZ bank).
      - `_id` string, required — A unique identifier for this institution, prefixed by `conn_`.
      - `name` string, required — The name of the institution.
      - `logo` string, uri, required — A URL pointing to a .png image of the institution's logo.
    - `status` 'PROCESSING' | 'COMPLETE' | 'ERROR', required — The status of the one-off data retrieval process: - `PROCESSING` → Akahu is still processing the result. Expect the status to shortly progress to either `COMPLETE` or `ERROR`. - `COMPLETE` → Akahu has finished processing the result and it is available for your application to retrieve. - `ERROR` → There was an error that meant the result could not be processed. See `status_reason` for more detail.
    - `status_reason` 'TIMEOUT' | 'PROCESSING_ERROR'
    - `available_results` object, required — A collection of boolean flags to indicate which results are available for fetching. While the result has a status of `PROCESSING`, these flags will be updated as data becomes available. This allows your application to fetch data and provide progress feedback to the user as quickly as possible. In general, `accounts`, `parties`, and `pdfs` results will be available almost immediately. Transactions undergo additional asynchronous processing, so may take a few seconds to become available. Once the result is assigned the `COMPLETE` state, these flags will no longer change.
      - `accounts` boolean — Account data is available to be fetched
      - `parties` boolean — Party data is available to be fetched
      - `transactions` boolean — Transaction data is available to be fetched
      - `pdfs` boolean — PDF files are available to be fetched
    - `available_accounts_count` integer — **Deprecated** This field is not available for official open banking connections. The total number of accounts that were available for the user to share with your application. They may have chosen a subset of these to share, which will be available from the [`GET /accounts/{code}`](/reference/get_accounts-code) endpoint.
    - `expires_at` string, date-time, required — When this result expires. After expiry it will no longer be accessible. Formatted as an ISO 8601 timestamp.
    - `created_at` string, date-time, required — Formatted as an ISO 8601 timestamp.
    - `updated_at` string, date-time — Formatted as an ISO 8601 timestamp.

## Other responses

- `400` — Your request was malformed or otherwise unacceptable. More details are provided under the `message` key in the response.
- `401` — You are not authorised to access this content.
- `403` — You are not allowed to access this content.
- `500` — An internal error has prevented us from processing the request. More detail may be supplied in the `message` key.

---

[API](https://skmtc.dev/akahu/apis/akahu-enduring-api.md) · [All operations](https://skmtc.dev/akahu/apis/akahu-enduring-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/akahu/akahu-enduring-api/revisions/b2de9915920d/schema)