API reference
Enrich
Every match has a reason. Open the product
GET/v1/enrichOpen ↗
One transaction. A link, so an answer somebody disagrees with is a link they can paste into a bug report.
| Query | |
|---|---|
description | the bank description, exactly as the feed wrote it — store numbers, suburbs and card fragments and all, because resolving those is most of the work |
amount | the amount, signed: credits positive, debits negative. |
setting | How far a reading may go past the rules: strict is the rules alone; balanced, the default, adds a modelled reading where its category stays at 95% precision or better; broad, at 90%; complete gives every line a category, guessing where nothing read it, and marks each guess. |
POST/v1/enrichKey
A list of transactions, up to 20,000 in one request, with the coverage of the whole list.
| Query | |
|---|---|
setting | How far a reading may go past the rules: strict is the rules alone; balanced, the default, adds a modelled reading where its category stays at 95% precision or better; broad, at 90%; complete gives every line a category, guessing where nothing read it, and marks each guess. |
{"transactions": [{"id": "1", "date": "2026-08-02", "description": "WOOLWORTHS 1248 RICHMOND", "amount": -142.86}], "setting": "balanced"}GET/v1/enrich/rulesOpen ↗
What the engine is made of: the categories it can assign and how many rules it holds.
GET/v1/enrich/accuracyOpen ↗
What it gets right, measured against payee lists nobody here chose, per category and per confidence band.
The detail under a category
Every reading’s category carries detail: what the line’s words settle beneath the category, or null where they settle nothing. It never changes the category.
{
"kind": "benefit",
"code": "age_pension",
"label": "Age Pension",
"act": "Social Security Act 1991",
"social_security_act": true,
"matched": "AGE PENSION"
}| Field | |
|---|---|
kind | benefit on government income, conduct on a fee, lender on a repayment or a loan received. |
code | Branch on it. The codes for each kind are below. |
label | The code in words. |
matched | The words in the description that settled it. |
act | A benefit only: the Act it is paid under, or null. |
social_security_act | A benefit only: whether it is a social security payment under the Social Security Act 1991, the question reg 28HB(6) asks of a small or medium loan. null where the line does not settle it. |
Government payment: benefit
Each is paid under the Social Security Act 1991, so a social security payment, unless another Act is named.
| code | label |
|---|---|
pensioner_education_supplement | Pensioner Education Supplement |
age_pension | Age Pension |
disability_support_pension | Disability Support Pension |
carer_payment | Carer Payment |
carer_allowance | Carer Allowance |
carer | Carer Payment or Carer Allowance |
parenting_payment | Parenting Payment |
jobseeker_payment | JobSeeker Payment |
youth_allowance | Youth Allowance |
austudy | Austudy |
abstudy | ABSTUDY the ABSTUDY scheme, an Australian Government program with no Act of its own |
special_benefit | Special Benefit |
mobility_allowance | Mobility Allowance |
crisis_payment | Crisis Payment |
family_tax_benefit | Family Tax Benefit A New Tax System (Family Assistance) Act 1999 |
parental_leave_pay | Parental Leave Pay Paid Parental Leave Act 2010 |
rent_assistance | Rent Assistance the Social Security Act 1991 or the family assistance law, whichever payment it is paid with |
veterans | A Veterans’ Affairs payment Veterans’ Entitlements Act 1986, or the Military Rehabilitation and Compensation Act 2004 |
ndis | An NDIS payment National Disability Insurance Scheme Act 2013 |
centrelink_pension | A Centrelink pension, not named further |
unspecified | A government payment the line does not name Not known |
Fee: conduct
| code | label |
|---|---|
dishonour | A dishonoured payment |
overdrawn | The account overdrawn |
late_payment | A late payment fee |
A refund or reversal of one of these fees has no detail: the fee was already counted.
Lender: lender
| code | label |
|---|---|
debt_collector | A debt collector or debt buyer |
pay_advance | A pay-advance app |
small_amount_lender | A lender whose products are commonly small amount credit contracts |