{
  "service": "Creditcrest Broker",
  "version": "1.0.0",
  "not_advice": "Creditcrest Technologies is not a credit provider, is not a credit assistance provider, and does not hold an Australian credit licence. Its software produces evidence; the licensee makes the decision.",
  "what_it_is": "A best interests duty file. It records and costs the options a broker chose; it does not choose, it does not write a reason, and it does not state that the duty was discharged.",
  "the_file_is_the_link": {
    "everywhere": 2000,
    "thisServer": 8000,
    "why": "A file here is its own link and nothing is stored, so the file is exactly as long as the address bar allows. 2,000 characters is the length that opens anywhere — it is Internet Explorer’s maximum of 2,083, which is the floor no other client went below. Past about 8,000 this server itself will refuse the request, because Node’s HTTP parser caps the whole header block at 16 KiB and the address is part of it.",
    "ifItIsTooLong": "A file that has outgrown a link is a real file, not a mistake. Shorten it by keeping the narrative where the licensee already keeps it and carrying the costing here, or seal it and keep the sealed artefact — the page at /broker/file.html is one self-contained HTML file that can be saved and filed. What this software will not do is quietly start a database and stop telling you where your consumer’s circumstances are held."
  },
  "query": {
    "amount": "dollars borrowed",
    "value": "what the property is worth. Not defaulted here, unlike Compare: a best interests file about a loan whose ratio nobody stated is a file about a loan nobody described, and a product whose rate depends on the ratio is not costed until it is given",
    "years": "the term",
    "purpose": "OWNER_OCCUPIED or INVESTMENT",
    "repayment": "PRINCIPAL_AND_INTEREST or INTEREST_ONLY",
    "io": "years of interest-only repayments",
    "offset": "the balance the consumer expects to hold in an offset account. RG 273.56 says the lowest rate is not necessarily the lowest cost and names the offset as the reason; the note to RG 273.98 asks for the offset calculation to be kept. Nothing is assumed: with no balance stated, an offset account contributes nothing and the page says so",
    "opt": "a product considered and available to this consumer, by its identifier. Repeat it for each one",
    "na": "a product considered and NOT available to this consumer, by its identifier. Repeat it",
    "nawhy.<identifier>": "why that product is not available to this consumer. RG 273.61(a) asks for it, so an `na` with no `nawhy` is a hole rather than an entry. The identifier in the name has its punctuation replaced by underscores, and the link the page draws shows exactly what to write",
    "obj": "something the consumer said they want, in their words. Repeat it",
    "m.priorities, m.objectives, m.situation, m.changes, m.access, m.expertise": "what was recorded against each of the matters RG 273.48 names",
    "rec": "the identifier of the option the broker recommended. Never defaulted",
    "why": "the broker’s reasons for it, in the broker’s words",
    "recby": "the person who made the recommendation",
    "recat": "the day it was made",
    "norec": "why no recommendation was made, where none was",
    "sole": "why only one option was presented — RG 273.89",
    "same": "why every option is from one credit provider — RG 273.95",
    "costwhy": "why a higher cost option was recommended — RG 273.54",
    "by, crn, lic, acl, agg": "the broker, their credit representative number, the licensee, its ACL, the aggregator",
    "ref": "the consumer’s file reference. A reference, not a name",
    "guide": "the day the credit guide was given to the consumer",
    "nc1, nc1why, nc2, nc2why, nc3, nc3why": "a type of product not considered, and why — RG 273.172. Three numbered slots rather than a repeated pair, because a form cannot keep two repeated lists in step once one of them is left blank",
    "conflict": "the broker’s note on commission and conflicts",
    "chose, choseat, chosenote": "what the consumer decided, when, and their note — RG 273.104",
    "cur.lender, cur.product, cur.rate, cur.balance, cur.years, cur.annual": "the loan being refinanced, for the break-even. The rate is typed as a percentage",
    "sw.discharge, sw.break, sw.registration, sw.valuation, sw.application, sw.settlement, sw.legal, sw.other": "what switching costs",
    "seal": "the day the broker sealed it, as YYYY-MM-DD. Supplying it is the act of sealing, and it is in the link because the hash is recomputed from the link every time the page is opened"
  },
  "endpoints": {
    "GET /v1/broker": {
      "what": "The best interests file for the query below, as data: every option costed, what the file still needs, and its seal."
    },
    "GET /v1/broker/fields": {
      "what": "This description: every field the file takes."
    }
  }
}