v1
latestOpenAPI 3.1.02026-07-2483219318.4 KBStatus
Get Result Status
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.
get/status/{code}
Path parameters
codestring required
The one-off authorization code, provided to your application by redirection to your redirect_uri upon the user's successful completion of the authorization flow.
Headers
Content-Typestring
Response
Successful response.
Example response
{
"items": [
{
"connection": {
"_id": "conn_cjgaawozb000001nyd111xixr",
"name": "ANZ",
"logo": "https://cdn.akahu.nz/logos/connections/conn_cjgaawozb000001nyd111xixr"
},
"status": "COMPLETE",
"status_reason": "PROCESSING_ERROR",
"available_results": {
"accounts": true,
"parties": true,
"transactions": true,
"pdfs": true
},
"available_accounts_count": 5
}
]
}