WorkspaceDarkLight
Contents

API reference

Broker

Keep the reasoning. Open the product

GET/v1/brokerOpen ↗

The best interests file for the query below, as data: every option costed, what the file still needs, and its seal.

GET/v1/broker/fieldsOpen ↗

This description: every field the file takes.

Query
amountdollars borrowed
valuewhat the property is worth.
yearsthe term
purposeOWNER_OCCUPIED or INVESTMENT
repaymentPRINCIPAL_AND_INTEREST or INTEREST_ONLY
ioyears of interest-only repayments
offsetthe balance the consumer expects to hold in an offset account.
opta product considered and available to this consumer, by its identifier.
naa product considered and NOT available to this consumer, by its identifier.
nawhy.<identifier>why that product is not available to this consumer.
objsomething the consumer said they want, in their words.
m.priorities, m.objectives, m.situation, m.changes, m.access, m.expertisewhat was recorded against each of the matters RG 273.48 names
recthe identifier of the option the broker recommended.
whythe broker’s reasons for it, in the broker’s words
recbythe person who made the recommendation
recatthe day it was made
norecwhy no recommendation was made, where none was
solewhy only one option was presented — RG 273.89
samewhy every option is from one credit provider — RG 273.95
costwhywhy a higher cost option was recommended — RG 273.54
by, crn, lic, acl, aggthe broker, their credit representative number, the licensee, its ACL, the aggregator
refthe consumer’s file reference.
guidethe day the credit guide was given to the consumer
nc1, nc1why, nc2, nc2why, nc3, nc3whya type of product not considered, and why — RG 273.172.
conflictthe broker’s note on commission and conflicts
chose, choseat, chosenotewhat the consumer decided, when, and their note — RG 273.104
cur.lender, cur.product, cur.rate, cur.balance, cur.years, cur.annualthe loan being refinanced, for the break-even.
sw.discharge, sw.break, sw.registration, sw.valuation, sw.application, sw.settlement, sw.legal, sw.otherwhat switching costs
sealthe day the broker sealed it, as YYYY-MM-DD.