{"openapi":"3.1.0","info":{"title":"Creditcrest API","version":"2026-10-22","summary":"Lending software for Australian credit providers, as an HTTP API.","description":"Every product is an HTTP API: JSON in, evidence out, nothing kept. The version is the date of the newest changelog entry (https://app.creditcresttechnologies.com.au/developers/changelog), sent on every /v1 answer as Creditcrest-Version.","contact":{"name":"Creditcrest Technologies Pty Ltd","email":"hello@creditcresttechnologies.com.au","url":"https://app.creditcresttechnologies.com.au/developers"}},"externalDocs":{"description":"Quickstart, guides and reference","url":"https://app.creditcresttechnologies.com.au/developers"},"servers":[{"url":"https://app.creditcresttechnologies.com.au"}],"tags":[{"name":"Broker","description":"Keep the reasoning.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/broker"}},{"name":"Compare","description":"Compare the whole cost.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/compare"}},{"name":"Small Amount","description":"Costs in dollars and dates.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/smallamount"}},{"name":"LoanManager","description":"A ledger that tells the story.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/loanmanager"}},{"name":"Operations","description":"Every handover is visible.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/operations"}},{"name":"Compliance","description":"Show what opens the gate.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/compliance"}},{"name":"Portal","description":"One account. A clear view.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/portal"}},{"name":"Book and reports","description":"The book, counted honestly.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/growth"}},{"name":"Intent","description":"Signals you can inspect.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/intent"}},{"name":"Statement","description":"Follow every figure.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/statement"}},{"name":"Identity","description":"Know what was verified.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/identity"}},{"name":"AML","description":"Due diligence, documented.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/aml"}},{"name":"Payments","description":"Movement with a record.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/payments"}},{"name":"Credit Reporting","description":"Report from the ledger.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/credit-reporting"}},{"name":"Complaints","description":"Every complaint accounted for.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/complaints"}},{"name":"Privacy","description":"Make data duties visible.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/privacy"}},{"name":"Documents","description":"The right version, in order.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/documents"}},{"name":"Apply","description":"Questions with a record.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/apply"}},{"name":"Score","description":"Measured against your own book.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/score"}},{"name":"Sign","description":"Sign it. Keep the proof.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/sign"}},{"name":"Authentication","description":"Keys, and what a key’s use comes to.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/authentication"}},{"name":"Hosted Application","description":"Your application, run for you.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/journey"}},{"name":"Capacity","description":"See the arithmetic.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/capacity"}},{"name":"Enrich","description":"Every match has a reason.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/enrich"}},{"name":"Index","description":"What the API is, and every endpoint.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference"}},{"name":"Collections","description":"Dates. Reasons. Next steps.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/collections"}},{"name":"Decisioning","description":"Your policy. Replayable.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/decisioning"}},{"name":"Record","description":"Sealed. Then append-only.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/record"}}],"paths":{"/v1/broker":{"get":{"operationId":"getBroker","tags":["Broker"],"summary":"The best interests file for the query below, as data","description":"The best interests file for the query below, as data: every option costed, what the file still needs, and its seal.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/broker#get-v1-broker"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"},"engine_version":{"type":"string"},"not_advice":{"type":"string"},"status":{"type":"string"},"as_at":{"type":"string"},"loan":{"type":"object","properties":{"amount":{"type":"number"},"value":{"type":["number","null"]},"years":{"type":"number"},"purpose":{"type":"string"},"repayment":{"type":"string"},"interestOnlyYears":{"type":"number"},"lvr":{"type":["number","null"]},"deposit":{"type":["number","null"]},"showAll":{"type":"boolean"}},"required":["amount","value","years","purpose","repayment","interestOnlyYears","lvr","deposit","showAll"]},"figures":{"type":"object","properties":{"source":{"type":"string"},"retrieved_at":{"type":"string"},"age_days":{"type":"number"},"brands_read":{"type":"number"},"brands_on_the_register":{"type":"number"},"products_read":{"type":"number"}},"required":["source","retrieved_at","age_days","brands_read","brands_on_the_register","products_read"]},"what_the_file_still_needs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"needs":{"type":"string"},"parameter":{"type":"string"},"reference":{"type":"string"},"quote":{"type":"string"},"detail":{},"each":{}},"required":["id","needs","parameter","reference","quote","detail","each"]}},"refused_by_the_engine":{"type":["string","null"]},"options_costed":{"type":"array","items":{"type":"object","properties":{"rank":{"type":"number"},"lender":{"type":"string"},"product":{"type":"string"},"rate":{"type":"number"},"monthly_repayment":{"type":"number"},"interest":{"type":"number"},"fees":{"type":"object","properties":{"upfront":{"type":"number"},"ongoing":{"type":"number"},"total":{"type":"number"},"dischargeIfExiting":{"type":"number"}},"required":["upfront","ongoing","total","dischargeIfExiting"]},"cost_of_credit":{"type":"number"},"cost_is_a_floor":{"type":"boolean"},"owing_at_end":{"type":"number"}},"required":["rank","lender","product","rate","monthly_repayment","interest","fees","cost_of_credit","cost_is_a_floor","owing_at_end"]}},"options_not_available_to_this_consumer":{"type":"array"},"considered_but_not_costed":{"type":"array"},"refinance":{},"seal":{},"link":{"type":"string"},"link_length":{"type":"number"},"could_not_read":{"type":"array"}},"required":["version","engine_version","not_advice","status","as_at","loan","figures","what_the_file_still_needs","refused_by_the_engine","options_costed","options_not_available_to_this_consumer","considered_but_not_costed","refinance","seal","link","link_length","could_not_read"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/broker/fields":{"get":{"operationId":"getBrokerFields","tags":["Broker"],"summary":"This description","description":"This description: every field the file takes.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/broker#get-v1-broker-fields"},"parameters":[{"name":"amount","in":"query","required":false,"description":"dollars borrowed","schema":{"type":"string"}},{"name":"value","in":"query","required":false,"description":"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","schema":{"type":"string"}},{"name":"years","in":"query","required":false,"description":"the term","schema":{"type":"string"}},{"name":"purpose","in":"query","required":false,"description":"OWNER_OCCUPIED or INVESTMENT","schema":{"type":"string"}},{"name":"repayment","in":"query","required":false,"description":"PRINCIPAL_AND_INTEREST or INTEREST_ONLY","schema":{"type":"string"}},{"name":"io","in":"query","required":false,"description":"years of interest-only repayments","schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"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","schema":{"type":"string"}},{"name":"opt","in":"query","required":false,"description":"a product considered and available to this consumer, by its identifier. Repeat it for each one","schema":{"type":"string"}},{"name":"na","in":"query","required":false,"description":"a product considered and NOT available to this consumer, by its identifier. Repeat it","schema":{"type":"string"}},{"name":"nawhy.<identifier>","in":"query","required":false,"description":"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","schema":{"type":"string"}},{"name":"obj","in":"query","required":false,"description":"something the consumer said they want, in their words. Repeat it","schema":{"type":"string"}},{"name":"m.priorities, m.objectives, m.situation, m.changes, m.access, m.expertise","in":"query","required":false,"description":"what was recorded against each of the matters RG 273.48 names","schema":{"type":"string"}},{"name":"rec","in":"query","required":false,"description":"the identifier of the option the broker recommended. Never defaulted","schema":{"type":"string"}},{"name":"why","in":"query","required":false,"description":"the broker’s reasons for it, in the broker’s words","schema":{"type":"string"}},{"name":"recby","in":"query","required":false,"description":"the person who made the recommendation","schema":{"type":"string"}},{"name":"recat","in":"query","required":false,"description":"the day it was made","schema":{"type":"string"}},{"name":"norec","in":"query","required":false,"description":"why no recommendation was made, where none was","schema":{"type":"string"}},{"name":"sole","in":"query","required":false,"description":"why only one option was presented — RG 273.89","schema":{"type":"string"}},{"name":"same","in":"query","required":false,"description":"why every option is from one credit provider — RG 273.95","schema":{"type":"string"}},{"name":"costwhy","in":"query","required":false,"description":"why a higher cost option was recommended — RG 273.54","schema":{"type":"string"}},{"name":"by, crn, lic, acl, agg","in":"query","required":false,"description":"the broker, their credit representative number, the licensee, its ACL, the aggregator","schema":{"type":"string"}},{"name":"ref","in":"query","required":false,"description":"the consumer’s file reference. A reference, not a name","schema":{"type":"string"}},{"name":"guide","in":"query","required":false,"description":"the day the credit guide was given to the consumer","schema":{"type":"string"}},{"name":"nc1, nc1why, nc2, nc2why, nc3, nc3why","in":"query","required":false,"description":"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","schema":{"type":"string"}},{"name":"conflict","in":"query","required":false,"description":"the broker’s note on commission and conflicts","schema":{"type":"string"}},{"name":"chose, choseat, chosenote","in":"query","required":false,"description":"what the consumer decided, when, and their note — RG 273.104","schema":{"type":"string"}},{"name":"cur.lender, cur.product, cur.rate, cur.balance, cur.years, cur.annual","in":"query","required":false,"description":"the loan being refinanced, for the break-even. The rate is typed as a percentage","schema":{"type":"string"}},{"name":"sw.discharge, sw.break, sw.registration, sw.valuation, sw.application, sw.settlement, sw.legal, sw.other","in":"query","required":false,"description":"what switching costs","schema":{"type":"string"}},{"name":"seal","in":"query","required":false,"description":"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","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"not_advice":{"type":"string"},"what_it_is":{"type":"string"},"the_file_is_the_link":{"type":"object","properties":{"everywhere":{"type":"number"},"thisServer":{"type":"number"},"why":{"type":"string"},"ifItIsTooLong":{"type":"string"}},"required":["everywhere","thisServer","why","ifItIsTooLong"]},"query":{"type":"object","additionalProperties":{"type":"string"}},"endpoints":{"type":"object","additionalProperties":{"type":"object","properties":{"what":{"type":"string"}},"required":["what"]}}},"required":["service","version","not_advice","what_it_is","the_file_is_the_link","query","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/back-book":{"get":{"operationId":"getBackBook","tags":["Compare"],"summary":"What a borrower is paying, against what their own lender and the rest of the imported data publish…","description":"What a borrower is paying, against what their own lender and the rest of the imported data publish today for a loan of the same shape at the same loan to value ratio.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/compare#get-v1-back-book"},"parameters":[{"name":"rate","in":"query","required":false,"description":"the rate being paid now, as a percentage (\"6.89\") or a fraction (\"0.0689\")","schema":{"type":"string"}},{"name":"lender","in":"query","required":false,"description":"the brand the loan is with, as the imported data names it","schema":{"type":"string"}},{"name":"amount","in":"query","required":false,"description":"the amount still owing, dollars","schema":{"type":"string"}},{"name":"value","in":"query","required":false,"description":"what the property is worth, dollars — this is what sets the ratio","schema":{"type":"string"}},{"name":"term","in":"query","required":false,"description":"years left on the loan","schema":{"type":"string"}},{"name":"age","in":"query","required":false,"description":"how old the loan is, years — optional, and used only to show what the ACCC measured","schema":{"type":"string"}},{"name":"purpose","in":"query","required":false,"description":"owner (default) or investor","schema":{"type":"string"}},{"name":"repayment","in":"query","required":false,"description":"principal_and_interest (default) or interest_only","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"what":{"type":"string"},"not_advice":{"type":"string"},"published_is_not_offered":{"type":"string"},"nothing_is_kept":{"type":"string"},"query":{"type":"object","properties":{"rate":{"type":"string"},"lender":{"type":"string"},"amount":{"type":"string"},"value":{"type":"string"},"term":{"type":"string"},"age":{"type":"string"},"purpose":{"type":"string"},"repayment":{"type":"string"}},"required":["rate","lender","amount","value","term","age","purpose","repayment"]},"loyalty_gap":{"type":"array","items":{"type":"object","properties":{"minYears":{"type":"number"},"maxYears":{"type":["number","null"]},"basisPoints":{"type":["number","null"]},"what":{"type":"string"}},"required":["minYears","maxYears","basisPoints","what"]}}},"required":["service","version","what","not_advice","published_is_not_offered","nothing_is_kept","query","loyalty_gap"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/small-amount":{"get":{"operationId":"getSmallAmount","tags":["Small Amount"],"summary":"The same costing, as data","description":"The same costing, as data.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/smallamount#get-v1-small-amount"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"what":{"type":"string"},"version":{"type":"string"},"engine":{"type":"string"},"compilations":{"type":"object","properties":{"act":{"type":"string"},"code":{"type":"string"},"regulations":{"type":"string"}},"required":["act","code","regulations"]},"reference":{},"classification":{"type":"object","properties":{"kind":{"type":"string"},"says":{"type":"string"},"smallAmount":{"type":"array","items":{"type":"object","properties":{"limb":{"type":"string"},"cite":{"type":"string"},"met":{"type":"boolean"},"says":{"type":"string"}},"required":["limb","cite","met","says"]}},"mediumAmount":{"type":"array","items":{"type":"object","properties":{"limb":{"type":"string"},"cite":{"type":"string"},"met":{"type":"boolean"},"says":{"type":"string"}},"required":["limb","cite","met","says"]}},"unresolved":{"type":"array"}},"required":["kind","says","smallAmount","mediumAmount","unresolved"]},"cost":{"type":"object","properties":{"version":{"type":"string"},"kind":{"type":"string"},"adjustedCreditAmount":{"type":"number"},"establishmentFee":{"type":"number"},"establishmentFeeCap":{"type":"number"},"monthlyFee":{"type":"number"},"monthlyFeeCap":{"type":"number"},"monthlyFees":{"type":"number"},"totalFees":{"type":"number"},"totalPayable":{"type":"number"},"costOfCreditShare":{"type":"number"},"costOfCreditSays":{"type":"string"},"defaultRecoveryCeiling":{"type":"number"},"schedule":{"type":"array","items":{"type":"object","properties":{"n":{"type":"number"},"date":{"type":"string"},"amount":{"type":"number"}},"required":["n","date","amount"]}},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","properties":{"amountOfCredit":{"type":"number"},"feesCapitalised":{"type":"number"},"cap":{"type":"number"},"share":{"type":"number"},"adjustedCreditAmount":{"type":"number"},"from":{"type":"string"}}}},"required":["step","what","amount","rule","inputs"]}},"gaps":{"type":"array","items":{"type":"string"}},"breaches":{"type":"array"},"feesAssumed":{"type":"boolean"},"complete":{"type":"boolean"},"classification":{"type":"object","properties":{"kind":{"type":"string"},"sacc":{"type":"array","items":{"type":"object","properties":{"limb":{"type":"string"},"cite":{"type":"string"},"met":{"type":"boolean"},"says":{"type":"string"}},"required":["limb","cite","met","says"]}},"macc":{"type":"array","items":{"type":"object","properties":{"limb":{"type":"string"},"cite":{"type":"string"},"met":{"type":"boolean"},"says":{"type":"string"}},"required":["limb","cite","met","says"]}},"says":{"type":"string"},"unresolved":{"type":"array"}},"required":["kind","sacc","macc","says","unresolved"]}},"required":["version","kind","adjustedCreditAmount","establishmentFee","establishmentFeeCap","monthlyFee","monthlyFeeCap","monthlyFees","totalFees","totalPayable","costOfCreditShare","costOfCreditSays","defaultRecoveryCeiling","schedule","lines","gaps","breaches","feesAssumed","complete","classification"]},"protected_earnings":{"type":"object","properties":{"version":{"type":"string"},"share":{"type":"number"},"availableIncomeMonthly":{"type":"number"},"incomeSource":{"type":"string"},"periods":{"type":"array","items":{"type":"object","properties":{"n":{"type":"number"},"from":{"type":"string"},"to":{"type":"string"},"days":{"type":"number"},"repayment":{"type":"number"},"otherSaccAmounts":{"type":"number"},"required":{"type":"number"},"availableIncome":{"type":"number"},"cap":{"type":"number"},"share":{"type":"number"},"headroom":{"type":"number"},"meets":{"type":"boolean"},"working":{"type":"string"}},"required":["n","from","to","days","repayment","otherSaccAmounts","required","availableIncome","cap","share","headroom","meets","working"]}},"tightest":{"type":"object","properties":{"n":{"type":"number"},"from":{"type":"string"},"to":{"type":"string"},"days":{"type":"number"},"repayment":{"type":"number"},"otherSaccAmounts":{"type":"number"},"required":{"type":"number"},"availableIncome":{"type":"number"},"cap":{"type":"number"},"share":{"type":"number"},"headroom":{"type":"number"},"meets":{"type":"boolean"},"working":{"type":"string"}},"required":["n","from","to","days","repayment","otherSaccAmounts","required","availableIncome","cap","share","headroom","meets","working"]},"meets":{"type":"boolean"},"failing":{"type":"array","items":{"type":"number"}},"understated":{"type":"boolean"},"gaps":{"type":"array"},"statement":{"type":"string"},"changed":{"type":"string"},"cite":{"type":"string"},"quote":{"type":"string"}},"required":["version","share","availableIncomeMonthly","incomeSource","periods","tightest","meets","failing","understated","gaps","statement","changed","cite","quote"]},"repayments":{"type":"object","properties":{"version":{"type":"string"},"findings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"cite":{"type":"string"},"met":{"type":"boolean"},"says":{"type":"string"}},"required":["code","cite","met","says"]}},"meets":{"type":"boolean"},"cite":{"type":"string"},"quote":{"type":"string"}},"required":["version","findings","meets","cite","quote"]},"findings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"cite":{"type":"string"},"quote":{"type":"string"},"repealed":{"type":"string"},"applies":{"type":"string"},"rebuts":{"type":["string","null"]},"statement":{"type":"string"},"evidence":{"type":"array"}},"required":["code","cite","quote","applies","rebuts","statement","evidence"]}},"gaps":{"type":"array","items":{"type":"string"}},"problems":{"type":"array"},"complete":{"type":"boolean"},"stores":{"type":"string"},"not_a_decision":{"type":"string"},"typed_income_is_not_verification":{"type":"string"},"protected_earnings_changed":{"type":"string"},"presumptions_were_repealed":{"type":"string"},"not_advice":{"type":"string"},"caps":{"type":"object","properties":{"saccCreditLimit":{"type":"number"},"maccCreditLimitFrom":{"type":"number"},"maccCreditLimitTo":{"type":"number"},"minimumTermDays":{"type":"number"},"saccMaximumTermYears":{"type":"number"},"maccMaximumTermYears":{"type":"number"},"establishmentFeeShare":{"type":"number"},"monthlyFeeShare":{"type":"number"},"defaultRecoveryMultiple":{"type":"number"},"protectedEarningsShare":{"type":"number"},"annualCostRateCap":{"type":"number"},"maccFeeOutsideTheRate":{"type":"number"},"lastRepaymentShortfall":{"type":"number"},"statementDays":{"type":"number"},"servicesAustraliaStatementDays":{"type":"number"}},"required":["saccCreditLimit","maccCreditLimitFrom","maccCreditLimitTo","minimumTermDays","saccMaximumTermYears","maccMaximumTermYears","establishmentFeeShare","monthlyFeeShare","defaultRecoveryMultiple","protectedEarningsShare","annualCostRateCap","maccFeeOutsideTheRate","lastRepaymentShortfall","statementDays","servicesAustraliaStatementDays"]},"takes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"kind":{"type":"string"},"label":{"type":"string"},"hint":{"type":["string","null"]},"required":{"type":"boolean"},"options":{"type":"array","items":{"type":"string"}}},"required":["name","kind","label","hint"]}},"examples":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"what":{"type":"string"},"query":{"type":"string"},"url":{"type":"string"}},"required":["title","what","query","url"]}},"endpoints":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","what","version","compilations","stores","not_a_decision","typed_income_is_not_verification","protected_earnings_changed","presumptions_were_repealed"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/small-amount/provisions":{"get":{"operationId":"getSmallAmountProvisions","tags":["Small Amount"],"summary":"The provisions, as data","description":"The provisions, as data.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/smallamount#get-v1-small-amount-provisions"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"compilations":{"type":"string"},"groups":{"type":"array","items":{"type":"object","properties":{"heading":{"type":"string"},"note":{"type":"string"},"keys":{"type":"array","items":{"type":"string"}},"provisions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"cite":{"type":"string"},"quote":{"type":"string"},"repealed":{"type":"string"}},"required":["key","cite","quote"]}}},"required":["heading","keys","provisions"]}}},"required":["compilations","groups"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/loanmanager":{"get":{"operationId":"getLoanmanager","tags":["LoanManager"],"summary":"The account from the page’s own query fields, as data","description":"The account from the page’s own query fields, as data","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#get-v1-loanmanager"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"what":{"type":"string"},"version":{"type":"string"},"engine":{"type":"string"},"not_a_decision":{"type":"string"},"stores":{"type":"string"},"reference":{},"kind":{"type":"string"},"ok":{"type":"boolean"},"as_at":{"type":"string"},"status":{"type":"string"},"paid_out_on":{"type":["string","null"]},"problems":{"type":"array"},"findings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"cite":{"type":"string"},"quote":{"type":"string"},"ceiling":{"type":"number"},"counted":{"type":"number"},"headroom":{"type":"number"},"enforcementExpensesOutside":{"type":"number"},"notCharged":{"type":"number"},"held":{"type":"array"},"breach":{"type":"boolean"},"says":{"type":"string"}},"required":["code","cite","quote","ceiling","counted","headroom","enforcementExpensesOutside","notCharged","held","breach","says"]}},"balances":{"type":"object","properties":{"principal":{"type":"number"},"establishmentFee":{"type":"number"},"monthlyFee":{"type":"number"},"interest":{"type":"number"},"otherFee":{"type":"number"},"dishonourFee":{"type":"number"},"collectionFee":{"type":"number"},"outstanding":{"type":"number"},"unappliedCredit":{"type":"number"},"net":{"type":"number"}},"required":["principal","establishmentFee","monthlyFee","interest","otherFee","dishonourFee","collectionFee","outstanding","unappliedCredit","net"]},"arrears":{"type":"object","properties":{"arrears":{"type":"number"},"oldestUnpaid":{"type":["string","null"]},"contractualDays":{"type":"number"},"pausedDays":{"type":"number"},"daysPastDue":{"type":"number"},"frozen":{},"method":{"type":"string"},"accountCharges":{"type":"number"}},"required":["arrears","oldestUnpaid","contractualDays","pausedDays","daysPastDue","frozen","method","accountCharges"]},"interest":{},"payout":{"type":"object","properties":{"on":{"type":"string"},"amount":{"type":"number"},"lines":{"type":"array","items":{"type":"object","properties":{"what":{"type":"string"},"amount":{"type":"number"}},"required":["what","amount"]}},"leavesOut":{"type":"string"},"cite":{"type":"string"},"rule":{"type":"string"},"mayChange":{"type":"string"},"says":{"type":"string"}},"required":["on","amount","lines"]},"allocation":{"type":"object","properties":{"version":{"type":"string"},"order":{"type":"array","items":{"type":"string"}}},"required":["version","order"]},"rows":{"type":"array","items":{"type":"object","properties":{"n":{"type":"number"},"due":{"type":"string"},"scheduled":{"type":"object","properties":{"principal":{"type":"number"},"establishmentFee":{"type":"number"},"monthlyFee":{"type":"number"},"interest":{"type":"number"},"otherFee":{"type":"number"}},"required":["principal","establishmentFee","monthlyFee","interest","otherFee"]},"owed":{"type":"object","properties":{"principal":{"type":"number"},"establishmentFee":{"type":"number"},"monthlyFee":{"type":"number"},"interest":{"type":"number"},"otherFee":{"type":"number"}},"required":["principal","establishmentFee","monthlyFee","interest","otherFee"]},"satisfied":{"type":"object","properties":{"principal":{"type":"number"},"establishmentFee":{"type":"number"},"monthlyFee":{"type":"number"},"interest":{"type":"number"},"otherFee":{"type":"number"}},"required":["principal","establishmentFee","monthlyFee","interest","otherFee"]},"unpaid":{"type":"number"},"cashPaid":{"type":"number"},"held":{"type":"number"},"status":{"type":"string"},"notCharged":{}},"required":["n","due","scheduled","owed","satisfied","unpaid","cashPaid","held","status","notCharged"]}},"account_charges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"part":{"type":"string"},"on":{"type":"string"},"amount":{"type":"number"},"unpaid":{"type":"number"},"enforcementExpense":{}},"required":["id","part","on","amount","unpaid","enforcementExpense"]}},"hardship":{"type":"array"},"transactions":{"type":"array","items":{"type":"object","properties":{"seq":{"type":"number"},"on":{"type":"string"},"type":{"type":"string"},"debit":{"type":"number"},"credit":{"type":"number"},"allocations":{"type":"array","items":{"type":"object","properties":{"row":{"type":["number","null"]},"charge":{"type":["string","null"]},"part":{"type":"string"},"kind":{"type":"string"},"amount":{"type":"number"}},"required":["row","charge","part","kind","amount"]}},"event":{"type":["string","null"]},"reverses":{"type":["string","null"]},"reason":{"type":["string","null"]},"by":{},"method":{},"reference":{},"outstanding":{"type":"number"},"unappliedCredit":{"type":"number"}},"required":["seq","on","type","debit","credit","allocations","event","reverses","reason","by","method","reference","outstanding","unappliedCredit"]}},"journal":{"type":"array","items":{"type":"object","properties":{"seq":{"type":"number"},"on":{"type":"string"},"type":{"type":"string"},"lines":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string"},"debit":{"type":"number"},"credit":{"type":"number"}},"required":["account","debit","credit"]}},"balanced":{"type":"boolean"}},"required":["seq","on","type","lines","balanced"]}},"replays":{"type":"array"},"takes":{"type":"object","properties":{"query":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"kind":{"type":"string"},"label":{"type":"string"},"hint":{"type":["string","null"]},"options":{"type":"array","items":{"type":"string"}}},"required":["name","kind","label","hint"]}},"events_line":{"type":"string"},"max_event_lines":{"type":"number"}},"required":["query","events_line","max_event_lines"]},"origination":{"type":"object","properties":{"application":{"type":"string"},"contract":{"type":"string"},"assessment_copy":{"type":"string"}},"required":["application","contract","assessment_copy"]},"endpoints":{"type":"object","additionalProperties":{"type":"string"}},"account_endpoint":{"type":"object","properties":{"method":{"type":"string"},"path":{"type":"string"},"body":{"type":"string"},"max_events":{"type":"number"}},"required":["method","path","body","max_events"]},"events":{"type":"object","additionalProperties":{"type":"string"}},"parts":{"type":"object","properties":{"principal":{"type":"string"},"establishmentFee":{"type":"string"},"monthlyFee":{"type":"string"},"interest":{"type":"string"},"otherFee":{"type":"string"},"dishonourFee":{"type":"string"},"collectionFee":{"type":"string"}},"required":["principal","establishmentFee","monthlyFee","interest","otherFee","dishonourFee","collectionFee"]},"accounts":{"type":"object","properties":{"loans":{"type":"string"},"fees":{"type":"string"},"interest":{"type":"string"},"cash":{"type":"string"},"feeIncome":{"type":"string"},"interestIncome":{"type":"string"},"customerCredit":{"type":"string"},"waivers":{"type":"string"},"principalWaived":{"type":"string"}},"required":["loans","fees","interest","cash","feeIncome","interestIncome","customerCredit","waivers","principalWaived"]},"examples":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"query":{"type":"string"},"url":{"type":"string"}},"required":["title","query","url"]}}},"required":["service","what","version","engine","not_a_decision","stores","allocation"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/loanmanager/application":{"post":{"operationId":"postLoanmanagerApplication","tags":["LoanManager"],"summary":"The application against the product version and form published on that day","description":"The application against the product version and form published on that day","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#post-v1-loanmanager-application"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{catalogue, product, onDay, request, form, answers, applicant}","content":{"application/json":{"schema":{"type":"object","description":"{catalogue, product, onDay, request, form, answers, applicant}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"engine":{"type":"string"},"not_a_decision":{"type":"string"},"stores":{"type":"string"},"product":{"type":["object","null"],"properties":{"product":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"}},"required":["product","version","name"]},"product_why":{"type":["string","null"]},"request":{"type":"object","properties":{"fits":{"type":["boolean","null"]},"problems":{"type":"array","items":{"type":"string"}},"version":{"type":"object","properties":{"product":{"type":"string"},"version":{"type":"string"}},"required":["product","version"]}},"required":["fits","problems"]},"answers":{"type":["object","null"],"properties":{"ok":{"type":"boolean"},"typed":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"type":{"type":"string"},"value":{"type":["string","number","boolean"]},"canonical":{"type":["string","null"]},"restricted":{"type":"boolean"}},"required":["key","type","value","canonical","restricted"]}},"problems":{"type":"array"},"form":{"type":"object","properties":{"key":{"type":"string"},"version":{"type":"string"}},"required":["key","version"]}},"required":["ok","typed","problems","form"]},"applicant":{"type":["object","null"],"properties":{"ok":{"type":"boolean"},"problems":{"type":"array"},"findings":{"type":"array"},"age":{"type":"number"},"normalised":{"type":"object","properties":{"email":{"type":"string"},"mobile":{},"name":{"type":"string"}},"required":["email","mobile","name"]}},"required":["ok","problems","findings","age","normalised"]},"form_binding":{"type":["object","null"],"properties":{"ok":{"type":"boolean"},"problems":{"type":"array"}},"required":["ok","problems"]},"code_applies":{},"fits_what_was_published":{"type":"boolean"},"says":{"type":"string"}},"required":["service","engine","not_a_decision","stores","product","product_why","request","answers","applicant","form_binding","code_applies","fits_what_was_published","says"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/loanmanager/contract":{"post":{"operationId":"postLoanmanagerContract","tags":["LoanManager"],"summary":"Where a contract stands, from prepared to funded","description":"Where a contract stands, from prepared to funded","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#post-v1-loanmanager-contract"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{contract: {pricing}, events: [{on, to}], asAt}","content":{"application/json":{"schema":{"type":"object","description":"{contract: {pricing}, events: [{on, to}], asAt}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"engine":{"type":"string"},"not_a_decision":{"type":"string"},"stores":{"type":"string"},"states":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"pricing_fields":{"type":"array","items":{"type":"string"}},"state":{"type":"string"},"history":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"on":{}},"required":["state","on"]}},"problems":{"type":"array","items":{"type":"string"}},"disclosedOn":{},"sentOn":{},"signedOn":{},"next":{"type":"array","items":{"type":"string"}},"copyOfContract":{},"mayTerminate":{}},"required":["service","engine","not_a_decision","stores","states","pricing_fields","state","history","problems","disclosedOn","sentOn","signedOn","next","copyOfContract","mayTerminate"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/loanmanager/assessment-copy":{"get":{"operationId":"getLoanmanagerAssessmentCopy","tags":["LoanManager"],"summary":"When the consumer’s copy of the assessment is due under s 132","description":"When the consumer’s copy of the assessment is due under s 132","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#get-v1-loanmanager-assessment-copy"},"parameters":[{"name":"requested","in":"query","required":false,"description":"YYYY-MM-DD","schema":{"type":"string"}},{"name":"credit","in":"query","required":false,"description":"YYYY-MM-DD","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"takes":{"type":"object","properties":{"requested":{"type":"string"},"credit":{"type":"string"}},"required":["requested","credit"]},"sources":{"type":"array","items":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]}},"due":{"type":"string"},"businessDays":{"type":"number"},"cite":{"type":"string"},"quote":{"type":"string"},"free":{"type":"string"},"says":{"type":"string"}}}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/loanmanager/account":{"post":{"operationId":"postLoanmanagerAccount","tags":["LoanManager"],"summary":"One loan replayed from its terms and what happened to it","description":"One loan replayed from its terms and what happened to it","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#post-v1-loanmanager-account"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{terms, events, asAt}","content":{"application/json":{"schema":{"type":"object","description":"{terms, events, asAt}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"what":{"type":"string"},"version":{"type":"string"},"engine":{"type":"string"},"not_a_decision":{"type":"string"},"stores":{"type":"string"},"reference":{"type":"string"},"kind":{"type":"string"},"ok":{"type":"boolean"},"as_at":{"type":"string"},"status":{"type":"string"},"paid_out_on":{},"problems":{"type":"array"},"findings":{"type":"array"},"balances":{"type":"object","properties":{"principal":{"type":"number"},"establishmentFee":{"type":"number"},"monthlyFee":{"type":"number"},"interest":{"type":"number"},"otherFee":{"type":"number"},"dishonourFee":{"type":"number"},"collectionFee":{"type":"number"},"outstanding":{"type":"number"},"unappliedCredit":{"type":"number"},"net":{"type":"number"}},"required":["principal","establishmentFee","monthlyFee","interest","otherFee","dishonourFee","collectionFee","outstanding","unappliedCredit","net"]},"arrears":{"type":"object","properties":{"arrears":{"type":"number"},"oldestUnpaid":{},"contractualDays":{"type":"number"},"pausedDays":{"type":"number"},"daysPastDue":{"type":"number"},"frozen":{},"method":{"type":"string"},"accountCharges":{"type":"number"}},"required":["arrears","oldestUnpaid","contractualDays","pausedDays","daysPastDue","frozen","method","accountCharges"]},"interest":{},"payout":{"type":"object","properties":{"on":{"type":"string"},"amount":{"type":"number"},"lines":{"type":"array","items":{"type":"object","properties":{"what":{"type":"string"},"amount":{"type":"number"}},"required":["what","amount"]}},"leavesOut":{"type":"string"},"cite":{"type":"string"},"rule":{"type":"string"},"mayChange":{"type":"string"}},"required":["on","amount","lines","leavesOut","cite","rule","mayChange"]},"allocation":{"type":"object","properties":{"version":{"type":"string"},"order":{"type":"array","items":{"type":"string"}}},"required":["version","order"]},"rows":{"type":"array","items":{"type":"object","properties":{"n":{"type":"number"},"due":{"type":"string"},"scheduled":{"type":"object","properties":{"principal":{"type":"number"},"establishmentFee":{"type":"number"},"monthlyFee":{"type":"number"},"interest":{"type":"number"},"otherFee":{"type":"number"}},"required":["principal","establishmentFee","monthlyFee","interest","otherFee"]},"owed":{"type":"object","properties":{"principal":{"type":"number"},"establishmentFee":{"type":"number"},"monthlyFee":{"type":"number"},"interest":{"type":"number"},"otherFee":{"type":"number"}},"required":["principal","establishmentFee","monthlyFee","interest","otherFee"]},"satisfied":{"type":"object","properties":{"principal":{"type":"number"},"establishmentFee":{"type":"number"},"monthlyFee":{"type":"number"},"interest":{"type":"number"},"otherFee":{"type":"number"}},"required":["principal","establishmentFee","monthlyFee","interest","otherFee"]},"unpaid":{"type":"number"},"cashPaid":{"type":"number"},"held":{"type":"number"},"status":{"type":"string"},"notCharged":{}},"required":["n","due","scheduled","owed","satisfied","unpaid","cashPaid","held","status","notCharged"]}},"account_charges":{"type":"array"},"hardship":{"type":"array"},"transactions":{"type":"array","items":{"type":"object","properties":{"seq":{"type":"number"},"on":{"type":"string"},"type":{"type":"string"},"debit":{"type":"number"},"credit":{"type":"number"},"allocations":{"type":"array","items":{"type":"object","properties":{"row":{"type":["number","null"]},"charge":{},"part":{"type":"string"},"kind":{"type":"string"},"amount":{"type":"number"}},"required":["row","charge","part","kind","amount"]}},"event":{"type":["string","null"]},"reverses":{},"reason":{"type":["string","null"]},"by":{},"method":{},"reference":{},"outstanding":{"type":"number"},"unappliedCredit":{"type":"number"}},"required":["seq","on","type","debit","credit","allocations","event","reverses","reason","by","method","reference","outstanding","unappliedCredit"]}},"journal":{"type":"array","items":{"type":"object","properties":{"seq":{"type":"number"},"on":{"type":"string"},"type":{"type":"string"},"lines":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string"},"debit":{"type":"number"},"credit":{"type":"number"}},"required":["account","debit","credit"]}},"balanced":{"type":"boolean"}},"required":["seq","on","type","lines","balanced"]}},"replays":{"type":"array"}},"required":["service","what","version","engine","not_a_decision","stores","reference","kind","ok","as_at","status","paid_out_on","problems","findings","balances","arrears","interest","payout","allocation","rows","account_charges","hardship","transactions","journal","replays"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/operations":{"get":{"operationId":"getOperations","tags":["Operations"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/operations#get-v1-operations"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"not_a_decision":{"type":"string"},"stores":{"type":"string"},"roles":{"type":"object","properties":{"assessor":{"type":"string"},"senior":{"type":"string"},"compliance":{"type":"string"},"admin":{"type":"string"},"auditor":{"type":"string"}},"required":["assessor","senior","compliance","admin","auditor"]},"events":{"type":"object","additionalProperties":{"type":"string"}},"example_workflow":{"type":"object","properties":{"key":{"type":"string"},"version":{"type":"string"},"status":{"type":"string"},"start":{"type":"string"},"states":{"type":"object","additionalProperties":{"type":"object","properties":{"limitDays":{"type":"number"},"what":{"type":"string"},"pauses":{"type":"boolean"},"terminal":{"type":"boolean"}},"required":["what"]}},"moves":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"checklist":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"required":{"type":"boolean"}},"required":["key","label","required"]}},"secondCheck":{"type":"array","items":{"type":"string"}}},"required":["key","version","status","start","states","moves","checklist","secondCheck"]},"endpoints":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","not_a_decision","stores","roles","events","example_workflow","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/operations/case":{"post":{"operationId":"postOperationsCase","tags":["Operations"],"summary":"The file replayed","description":"The file replayed","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/operations#post-v1-operations-case"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{workflow?, people, events, asAt, holidays?, reference?, priority?}","content":{"application/json":{"schema":{"type":"object","description":"{workflow?, people, events, asAt, holidays?, reference?, priority?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"version":{"type":"string"},"reference":{},"workflow":{"type":"object","properties":{"key":{"type":"string"},"version":{"type":"string"}},"required":["key","version"]},"priority":{"type":"number"},"openedOn":{"type":["string","null"]},"state":{"type":["string","null"]},"stateSince":{"type":["string","null"]},"holder":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"checklist":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"required":{"type":"boolean"},"status":{"type":"string"},"by":{"type":["string","null"]},"on":{"type":["string","null"]},"note":{"type":["string","null"]},"version":{"type":"number"}},"required":["key","label","required","status","by","on","note","version"]}},"checklistComplete":{"type":"boolean"},"notes":{"type":"array"},"documents":{"type":"array"},"documentsOverdue":{"type":"array"},"extractions":{"type":"array"},"figures":{"type":"array"},"rebuttals":{"type":"array"},"conclusion":{"type":["object","null"],"properties":{"conclusion":{"type":"string"},"says":{"type":"string"},"by":{"type":"string"},"name":{"type":"string"},"on":{"type":"string"},"reasons":{"type":"string"},"status":{"type":"string"},"confirmedBy":{},"confirmedOn":{}},"required":["conclusion","says","by","name","on","reasons","status","confirmedBy","confirmedOn"]},"sla":{"type":["object","null"],"properties":{"state":{"type":"string"},"since":{"type":"string"},"limitDays":{"type":"number"},"dueOn":{"type":"string"},"used":{"type":"number"},"breached":{"type":"boolean"},"says":{"type":"string"}},"required":["state","since","limitDays","dueOn","used","breached","says"]},"audit":{"type":"array","items":{"type":"object","properties":{"on":{"type":"string"},"type":{"type":"string"},"by":{"type":["string","null"]},"name":{"type":["string","null"]},"to":{"type":"string"},"toName":{"type":"string"},"item":{"type":"string"},"status":{"type":"string"},"conclusion":{"type":"string"}},"required":["on","type","by","name"]}},"problems":{"type":"array"},"notADecision":{"type":"string"}},"required":["ok","version","reference","workflow","priority","openedOn","state","stateSince","holder","checklist","checklistComplete","notes","documents","documentsOverdue","extractions","figures","rebuttals","conclusion","sla","audit","problems","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/operations/queue":{"post":{"operationId":"postOperationsQueue","tags":["Operations"],"summary":"The queue, in the order to pick files up","description":"The queue, in the order to pick files up","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/operations#post-v1-operations-queue"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{workflow?, people, cases: [{reference, priority, events}], asAt}","content":{"application/json":{"schema":{"type":"object","description":"{workflow?, people, cases: [{reference, priority, events}], asAt}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"queue":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"state":{"type":"string"},"holder":{},"priority":{"type":"number"},"openedOn":{"type":"string"},"breached":{"type":"boolean"},"dueOn":{"type":"string"},"awaitingSecondCheck":{"type":"boolean"},"closed":{"type":"boolean"},"checklist":{"type":"object","properties":{"done":{"type":"number"},"total":{"type":"number"}},"required":["done","total"]}},"required":["reference","state","holder","priority","openedOn","breached","dueOn","awaitingSecondCheck","closed","checklist"]}},"refused":{"type":"array"}},"required":["queue","refused"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/compliance":{"get":{"operationId":"getCompliance","tags":["Compliance"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/compliance#get-v1-compliance"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"not_an_opinion":{"type":"string"},"stores":{"type":"string"},"required_gates":{"type":"object","additionalProperties":{"type":"string"}},"capabilities":{"type":"object","additionalProperties":{"type":"string"}},"modes":{"type":"array","items":{"type":"string"}},"evidenced":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"cite":{"type":"string"},"quote":{"type":"string"},"product":{"type":"string"},"evidence":{"type":"string"}},"required":["id","cite","quote","product","evidence"]}},"endpoints":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","not_an_opinion","stores","required_gates","capabilities","modes","evidenced","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/compliance/readiness":{"post":{"operationId":"postComplianceReadiness","tags":["Compliance"],"summary":"POST /v1/compliance/readiness","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/compliance#post-v1-compliance-readiness"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{gates: [{key, status, attestedBy, attestedOn, evidence, expiresOn, mandatory}], asAt, environment?, required?}","content":{"application/json":{"schema":{"type":"object","description":"{gates: [{key, status, attestedBy, attestedOn, evidence, expiresOn, mandatory}], asAt, environment?, required?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"environment":{"type":"string"},"asAt":{"type":["string","null"]},"ready":{"type":"boolean"},"blocking":{"type":"array","items":{"type":"object","properties":{"gate":{"type":"string"},"why":{"type":"string"}},"required":["gate","why"]}},"gates":{"type":"array"},"says":{"type":"string"},"notAnOpinion":{"type":"string"}},"required":["environment","asAt","ready","blocking","gates","says","notAnOpinion"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/compliance/capabilities":{"post":{"operationId":"postComplianceCapabilities","tags":["Compliance"],"summary":"Shadow on turns off everything but keeping records","description":"Shadow on turns off everything but keeping records","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/compliance#post-v1-compliance-capabilities"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{mode, enabled: [...], approvals: {legalLaunch, creditLicence, afcaMembership, providersProduction}, shadow?}","content":{"application/json":{"schema":{"type":"object","description":"{mode, enabled: [...], approvals: {legalLaunch, creditLicence, afcaMembership, providersProduction}, shadow?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"each":{"type":"array","items":{"type":"object","properties":{"capability":{"type":"string"},"allowed":{"type":"boolean"},"code":{"type":"string"},"why":{"type":"string"},"mode":{"type":"string"}},"required":["capability","allowed","code","why","mode"]}},"moneyCanMove":{"type":"boolean"},"mode":{"type":"string"},"shadow":{"type":"boolean"}},"required":["each","moneyCanMove","mode","shadow"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/compliance/changes":{"post":{"operationId":"postComplianceChanges","tags":["Compliance"],"summary":"POST /v1/compliance/changes","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/compliance#post-v1-compliance-changes"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{requests: [{id, control, change, requestedBy, approvedBy, approvedOn, rejectedBy}], approvers: [...]}","content":{"application/json":{"schema":{"type":"object","description":"{requests: [{id, control, change, requestedBy, approvedBy, approvedOn, rejectedBy}], approvers: [...]}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"changes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"state":{"type":"string"},"stands":{"type":"boolean"},"problems":{"type":"array","items":{"type":"string"}}},"required":["id","state","stands","problems"]}}},"required":["changes"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/compliance/target-market":{"post":{"operationId":"postComplianceTargetMarket","tags":["Compliance"],"summary":"POST /v1/compliance/target-market","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/compliance#post-v1-compliance-target-market"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{tmd: {criteria, channels, reviewEveryDays, triggers}, facts, channel, asAt, metrics}","content":{"application/json":{"schema":{"type":"object","description":"{tmd: {criteria, channels, reviewEveryDays, triggers}, facts, channel, asAt, metrics}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"check":{"type":"object","properties":{"product":{"type":["string","null"]},"version":{"type":["string","null"]},"inside":{"type":"boolean"},"criteria":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"what":{"type":"string"},"value":{"type":["string","number"]},"inside":{"type":"boolean"}},"required":["key","what","value","inside"]}},"channel":{"type":"object","properties":{"channel":{"type":["string","null"]},"allowed":{"type":"boolean"}},"required":["channel","allowed"]},"says":{"type":"string"},"law":{"type":"string"}},"required":["product","version","inside","criteria","channel","says","law"]},"review":{"type":"object","properties":{"due":{"type":"boolean"},"reasons":{"type":"array","items":{"type":"string"}},"lastReviewedOn":{"type":["string","null"]}},"required":["due","reasons","lastReviewedOn"]}},"required":["check","review"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/compliance/traceability":{"post":{"operationId":"postComplianceTraceability","tags":["Compliance"],"summary":"POST /v1/compliance/traceability","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/compliance#post-v1-compliance-traceability"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{matrix: {obligations, controls, tests, evidence}, asAt}","content":{"application/json":{"schema":{"type":"object","description":"{matrix: {obligations, controls, tests, evidence}, asAt}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"asAt":{"type":["string","null"]},"rows":{"type":"array","items":{"type":"object","properties":{"obligation":{"type":"string"},"cite":{},"what":{},"controls":{"type":"array"},"tests":{"type":"array"},"evidence":{"type":"array"},"gaps":{"type":"array","items":{"type":"string"}},"covered":{"type":"boolean"}},"required":["obligation","cite","what","controls","tests","evidence","gaps","covered"]}},"covered":{"type":"number"},"obligations":{"type":"number"},"orphanControls":{"type":"array"},"says":{"type":"string"},"notAnOpinion":{"type":"string"}},"required":["asAt","rows","covered","obligations","orphanControls","says","notAnOpinion"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/portal":{"get":{"operationId":"getPortal","tags":["Portal"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/portal#get-v1-portal"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"says":{"type":"string"},"stores":{"type":"string"},"brand_required":{"type":"array","items":{"type":"string"}},"s133cf":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"},"consequence":{"type":"string"}},"required":["cite","quote","consequence"]},"example_templates":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"version":{"type":"number"},"channel":{"type":"string"},"purpose":{"type":"string"},"variables":{"type":"array","items":{"type":"string"}},"body":{"type":"string"},"subject":{"type":"string"}},"required":["key","version","channel","purpose","variables","body"]}},"endpoints":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","says","stores","brand_required","s133cf","example_templates","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/portal/account":{"post":{"operationId":"postPortalAccount","tags":["Portal"],"summary":"The borrower’s view of their account, from the ledger","description":"The borrower’s view of their account, from the ledger","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/portal#post-v1-portal-account"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{brands, asAt, terms, events}","content":{"application/json":{"schema":{"type":"object","description":"{brands, asAt, terms, events}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"reference":{"type":"string"},"asAt":{"type":"string"},"status":{"type":"string"},"lines":{"type":"array","items":{"type":"string"}},"owed":{"type":"number"},"nextRepayment":{"type":"object","properties":{"due":{"type":"string"},"amount":{"type":"number"}},"required":["due","amount"]},"arrangement":{},"hardshipRequest":{},"overdue":{"type":"object","properties":{"amount":{"type":"number"},"since":{"type":"string"},"days":{"type":"number"}},"required":["amount","since","days"]},"afterSchedule":{},"payout":{"type":"object","properties":{"amount":{"type":"number"},"on":{"type":"string"},"lines":{"type":"array","items":{"type":"object","properties":{"what":{"type":"string"},"amount":{"type":"number"}},"required":["what","amount"]}},"mayChange":{"type":"string"},"says":{"type":"string"},"rule":{"type":"string"}},"required":["amount","on","lines","mayChange","says","rule"]},"rights":{"type":"array","items":{"type":"object","properties":{"what":{"type":"string"},"says":{"type":"string"},"cite":{"type":"string"},"quote":{"type":"string"},"contact":{"type":"string"}},"required":["what","says"]}},"activity":{"type":"array","items":{"type":"object","properties":{"on":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"balance":{"type":"number"}},"required":["on","what","amount","balance"]}},"lender":{"type":"object","properties":{"name":{"type":"string"},"legalName":{"type":"string"},"abn":{"type":"string"},"creditLicence":{"type":"string"},"phone":{"type":"string"}},"required":["name","legalName","abn","creditLicence","phone"]}},"required":["ok","reference","asAt","status","lines","owed","nextRepayment","arrangement","hardshipRequest","overdue","afterSchedule","payout","rights","activity","lender"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/portal/render":{"post":{"operationId":"postPortalRender","tags":["Portal"],"summary":"A message, rendered, or why not","description":"A message, rendered, or why not","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/portal#post-v1-portal-render"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{template, variables}","content":{"application/json":{"schema":{"type":"object","description":"{template, variables}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"key":{"type":"string"},"version":{"type":"number"},"channel":{"type":"string"},"purpose":{"type":"string"},"subject":{},"body":{"type":"string"},"segments":{"type":"number"}},"required":["ok","key","version","channel","purpose","subject","body","segments"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/portal/may-contact":{"post":{"operationId":"postPortalMayContact","tags":["Portal"],"summary":"POST /v1/portal/may-contact","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/portal#post-v1-portal-may-contact"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{purpose, channel, offersSmallAmountCredit, requestedByConsumer, recipient, recentSends, frequencyCap, journeyOver, onDay}","content":{"application/json":{"schema":{"type":"object","description":"{purpose, channel, offersSmallAmountCredit, requestedByConsumer, recipient, recentSends, frequencyCap, journeyOver, onDay}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"allowed":{"type":"boolean"},"step":{"type":"number"},"code":{"type":"string"},"why":{"type":"string"},"cite":{"type":"string"}},"required":["allowed","step","code","why"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/growth":{"get":{"operationId":"getGrowth","tags":["Book and reports"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/growth#get-v1-growth"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"says":{"type":"string"},"stores":{"type":"string"},"events":{"type":"array","items":{"type":"string"}},"funnel":{"type":"array","items":{"type":"string"}},"journeys":{"type":"object","additionalProperties":{"type":"object","properties":{"purpose":{"type":"string"},"trigger":{"type":"string"},"steps":{"type":"array","items":{"type":"object","properties":{"after":{"type":"string"},"channel":{"type":"string"}},"required":["after","channel"]}},"stopsOn":{"type":"array","items":{"type":"string"}},"stopsWhen":{"type":"array","items":{"type":"string"}},"maxReminders":{"type":"number"},"rule":{"type":"string"},"offersSmallAmountCredit":{"type":"boolean"}},"required":["purpose","trigger","steps","stopsOn","stopsWhen","maxReminders","rule"]}},"experiments_may_not_change":{"type":"array","items":{"type":"string"}},"endpoints":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","says","stores","events","funnel","journeys","experiments_may_not_change","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/growth/check-event":{"post":{"operationId":"postGrowthCheckEvent","tags":["Book and reports"],"summary":"The problems with an event, if any","description":"The problems with an event, if any","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/growth#post-v1-growth-check-event"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{event, now}","content":{"application/json":{"schema":{"type":"object","description":"{event, now}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"keep":{"type":"boolean"},"problems":{"type":"array","items":{"type":"string"}},"attribution":{"type":"object","properties":{"attribution":{"type":"object","properties":{"source":{"type":"string"},"medium":{},"campaign":{},"landingPath":{},"referrerHost":{}},"required":["source","medium","campaign","landingPath","referrerHost"]},"problems":{"type":"array"}},"required":["attribution","problems"]}},"required":["keep","problems","attribution"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/growth/funnel":{"post":{"operationId":"postGrowthFunnel","tags":["Book and reports"],"summary":"The funnel in people, and cost per funded loan","description":"The funnel in people, and cost per funded loan","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/growth#post-v1-growth-funnel"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{events, from, to, spend?}","content":{"application/json":{"schema":{"type":"object","description":"{events, from, to, spend?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"funnel":{"type":"object","properties":{"from":{"type":["string","null"]},"to":{"type":["string","null"]},"mode":{"type":"string"},"steps":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"people":{"type":"number"},"fromPrevious":{"type":["number","null"]}},"required":["step","people","fromPrevious"]}},"startedToFunded":{"type":["number","null"]}},"required":["from","to","mode","steps","startedToFunded"]},"cost":{"type":"object","properties":{"spend":{"type":"number"},"funded":{"type":"number"},"costPerFunded":{"type":["number","null"]},"says":{"type":["string","null"]}},"required":["spend","funded","costPerFunded","says"]}},"required":["funnel","cost"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/growth/experiment":{"post":{"operationId":"postGrowthExperiment","tags":["Book and reports"],"summary":"Whether it may run","description":"Whether it may run","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/growth#post-v1-growth-experiment"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{experiment, running, onDay}","content":{"application/json":{"schema":{"type":"object","description":"{experiment, running, onDay}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"mayRun":{"type":"boolean"},"problems":{"type":"array","items":{"type":"string"}}},"required":["mayRun","problems"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/growth/guardrails":{"post":{"operationId":"postGrowthGuardrails","tags":["Book and reports"],"summary":"Whether growth pauses","description":"Whether growth pauses","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/growth#post-v1-growth-guardrails"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{metrics, limits}","content":{"application/json":{"schema":{"type":"object","description":"{metrics, limits}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"pause":{"type":"boolean"},"breaches":{"type":"array","items":{"type":"object","properties":{"measure":{"type":"string"},"why":{"type":"string"}},"required":["measure","why"]}},"says":{"type":"string"}},"required":["pause","breaches","says"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/loanmanager/book":{"post":{"operationId":"postLoanmanagerBook","tags":["Book and reports"],"summary":"The book added up on a day","description":"The book added up on a day","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/growth#post-v1-loanmanager-book"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{asAt, accounts: [{terms, events}], collectionsFrom?, collectionsTo?}","content":{"application/json":{"schema":{"type":"object","description":"{asAt, accounts: [{terms, events}], collectionsFrom?, collectionsTo?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"book":{"type":"object","properties":{"version":{"type":"string"},"asAt":{"type":["string","null"]},"accounts":{"type":"number"},"open":{"type":"number"},"paidOut":{"type":"number"},"inHardship":{"type":"number"},"outstanding":{"type":"number"},"arrears":{"type":"number"},"writtenOff":{"type":"number"},"writtenOffHardshipRelief":{"type":"number"},"recovered":{"type":"number"},"arrearsShare":{"type":["number","null"]},"bands":{"type":"array","items":{"type":"object","properties":{"band":{"type":"string"},"label":{"type":"string"},"colour":{"type":"string"},"text":{"type":"string"},"accounts":{"type":"number"},"outstanding":{"type":"number"}},"required":["band","label","colour","text","accounts","outstanding"]}},"byKind":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"accounts":{"type":"number"},"outstanding":{"type":"number"}},"required":["kind","accounts","outstanding"]}},"vintages":{"type":"array","items":{"type":"object","properties":{"vintage":{"type":"string"},"accounts":{"type":"number"},"advanced":{"type":"number"},"outstanding":{"type":"number"},"inArrears":{"type":"number"},"paidOut":{"type":"number"}},"required":["vintage","accounts","advanced","outstanding","inArrears","paidOut"]}},"problems":{"type":"array"}},"required":["version","asAt","accounts","open","paidOut","inHardship","outstanding","arrears","writtenOff","writtenOffHardshipRelief","recovered","arrearsShare","bands","byKind","vintages","problems"]},"bands":{"type":"array","items":{"type":"object","properties":{"band":{"type":"string"},"label":{"type":"string"},"colour":{"type":"string"},"text":{"type":"string"},"from":{"type":"number"},"to":{"type":["number","null"]}},"required":["band","label","colour","text"]}},"collections":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"days":{"type":"array","items":{"type":"object","properties":{"on":{"type":"string"},"expected":{"type":"number"},"collected":{"type":"number"},"dishonoured":{"type":"number"},"refunded":{"type":"number"},"waived":{"type":"number"}},"required":["on","expected","collected","dishonoured","refunded","waived"]}},"expected":{"type":"number"},"collected":{"type":"number"},"dishonoured":{"type":"number"},"collectedNet":{"type":"number"},"refunded":{"type":"number"},"waived":{"type":"number"},"collectionRate":{"type":"number"},"byMethod":{"type":"array","items":{"type":"object","properties":{"method":{"type":"string"},"payments":{"type":"number"},"collected":{"type":"number"},"dishonoured":{"type":"number"},"dishonourRate":{"type":"number"}},"required":["method","payments","collected","dishonoured","dishonourRate"]}},"says":{"type":"string"}},"required":["from","to","days","expected","collected","dishonoured","collectedNet","refunded","waived","collectionRate","byMethod","says"]}},"required":["book","bands"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/intent":{"get":{"operationId":"getIntent","tags":["Intent"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/intent#get-v1-intent"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"says":{"type":"string"},"stores":{"type":"string"},"signals":{"type":"object","properties":{"cured_arrears":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"paid_after_default":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"hardship_notice_early":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"arrangement_kept":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"partial_payments":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"promises_kept":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"candid_declaration":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"other_lenders_paid":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"prior_loans_completed":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"mandate_cancelled_early":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"bank_disconnected":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"first_payment_default_with_capacity":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"promises_broken":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"unreachable_after_default":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"contact_details_abandoned":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"declaration_contradicted":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]},"repeated_dishonour_no_replacement":{"type":"object","properties":{"weight":{"type":"number"},"what":{"type":"string"}},"required":["weight","what"]}},"required":["cured_arrears","paid_after_default","hardship_notice_early","arrangement_kept","partial_payments","promises_kept","candid_declaration","other_lenders_paid","prior_loans_completed","mandate_cancelled_early","bank_disconnected","first_payment_default_with_capacity","promises_broken","unreachable_after_default","contact_details_abandoned","declaration_contradicted","repeated_dishonour_no_replacement"]},"endpoints":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","says","stores","signals","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/intent/read":{"post":{"operationId":"postIntentRead","tags":["Intent"],"summary":"POST /v1/intent/read","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/intent#post-v1-intent-read"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{accounts: [{terms, events, asAt}], conduct, reading?, declared? (Creditcrest Apply’s feeds.intent), assessedSurplus?, weights?}","content":{"application/json":{"schema":{"type":"object","description":"{accounts: [{terms, events, asAt}], conduct, reading?, declared? (Creditcrest Apply’s feeds.intent), assessedSurplus?, weights?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"},"index":{"type":"number"},"band":{"type":"string"},"signals":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"weight":{"type":"number"},"what":{"type":"string"},"evidence":{"type":"array","items":{"type":"string"}},"account":{"type":"string"}},"required":["code","weight","what","evidence","account"]}},"promises":{"type":"object","properties":{"promises":{"type":"array","items":{"type":"object","properties":{"made":{"type":"string"},"by":{"type":"string"},"amount":{"type":"number"},"paid":{"type":"number"},"kept":{"type":"boolean"}},"required":["made","by","amount","paid","kept"]}},"made":{"type":"number"},"kept":{"type":"number"},"confidence":{"type":"number"},"restsOn":{"type":"string"}},"required":["promises","made","kept","confidence","restsOn"]},"evidenceCount":{"type":"number"},"calibrated":{"type":"boolean"},"says":{"type":"string"},"notADecision":{"type":"string"}},"required":["version","index","band","signals","promises","evidenceCount","calibrated","says","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/intent/calibrate":{"post":{"operationId":"postIntentCalibrate","tags":["Intent"],"summary":"POST /v1/intent/calibrate","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/intent#post-v1-intent-calibrate"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{outcomes: [{index, outcome}]}","content":{"application/json":{"schema":{"type":"object","description":"{outcomes: [{index, outcome}]}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","additionalProperties":{"type":["string","number","null"]}}},"separation":{"type":["number","null"]},"says":{"type":"string"}},"required":["rows","separation","says"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/evidence":{"get":{"operationId":"getEvidence","tags":["Statement"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/statement#get-v1-evidence"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"periods":{"type":"object","properties":{"sacc":{"type":"object","properties":{"days":{"type":"number"},"floor":{"type":"number"},"basis":{"type":"string"},"source":{"type":"string"}},"required":["days","floor","basis","source"]},"lease":{"type":"object","properties":{"days":{"type":"number"},"floor":{"type":"number"},"basis":{"type":"string"},"source":{"type":"string"}},"required":["days","floor","basis","source"]},"macc":{"type":"object","properties":{"days":{"type":"number"},"floor":{"type":"number"},"basis":{"type":"string"},"source":{"type":"string"}},"required":["days","floor","basis","source"]},"personal":{"type":"object","properties":{"days":{"type":"number"},"floor":{"type":"number"},"basis":{"type":"string"},"source":{"type":"string"}},"required":["days","floor","basis","source"]},"car":{"type":"object","properties":{"days":{"type":"number"},"floor":{"type":"number"},"basis":{"type":"string"},"source":{"type":"string"}},"required":["days","floor","basis","source"]},"home":{"type":"object","properties":{"days":{"type":"number"},"floor":{"type":"number"},"basis":{"type":"string"},"source":{"type":"string"}},"required":["days","floor","basis","source"]}},"required":["sacc","lease","macc","personal","car","home"]},"endpoints":{"type":"object","additionalProperties":{"type":"string"}}},"required":["periods","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/evidence/coverage":{"post":{"operationId":"postEvidenceCoverage","tags":["Statement"],"summary":"POST /v1/evidence/coverage","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/statement#post-v1-evidence-coverage"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{product, accounts: [{id, role, from, to}], applicationDay, selfEmployed?, refinancing?, policy?}","content":{"application/json":{"schema":{"type":"object","description":"{product, accounts: [{id, role, from, to}], applicationDay, selfEmployed?, refinancing?, policy?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"requirement":{"type":"object","properties":{"ok":{"type":"boolean"},"product":{"type":"string"},"incomeAccountDays":{"type":"number"},"refinancedLoanDays":{},"why":{"type":"string"},"statutory":{"type":"boolean"},"problems":{"type":"array"}},"required":["ok","product","incomeAccountDays","refinancedLoanDays","why","statutory","problems"]},"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"needs":{"type":"number"},"covered":{"type":"boolean"},"gaps":{"type":"array"}},"required":["id","role","needs","covered","gaps"]}},"complete":{"type":"boolean"}},"required":["ok","requirement","accounts","complete"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/identity":{"get":{"operationId":"getIdentity","tags":["Identity"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/identity#get-v1-identity"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"not_a_decision":{"type":"string"},"stores":{"type":"string"},"endpoints":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","not_a_decision","stores","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/identity/contact/start":{"post":{"operationId":"postIdentityContactStart","tags":["Identity"],"summary":"POST /v1/identity/contact/start","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/identity#post-v1-identity-contact-start"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{channel: email|mobile, destination, lender}","content":{"application/json":{"schema":{"type":"object","description":"{channel: email|mobile, destination, lender}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"},"hint":{"type":"string"},"resendAfter":{"type":"string"},"expiresAt":{"type":"string"},"sent":{"type":"boolean"},"why":{"type":["string","null"]},"code":{"type":"string"}},"required":["token","hint","resendAfter","expiresAt","sent","why"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/identity/contact/resend":{"post":{"operationId":"postIdentityContactResend","tags":["Identity"],"summary":"POST /v1/identity/contact/resend","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/identity#post-v1-identity-contact-resend"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{token}","content":{"application/json":{"schema":{"type":"object","description":"{token}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"},"hint":{"type":"string"},"resendAfter":{"type":"string"},"expiresAt":{"type":"string"},"sent":{"type":"boolean"},"why":{}},"required":["token","hint","resendAfter","expiresAt","sent","why"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/identity/contact/check":{"post":{"operationId":"postIdentityContactCheck","tags":["Identity"],"summary":"POST /v1/identity/contact/check","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/identity#post-v1-identity-contact-check"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{token, code}","content":{"application/json":{"schema":{"type":"object","description":"{token, code}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"outcome":{"type":"string"},"why":{"type":["string","null"]},"token":{"type":"string"},"hint":{"type":"string"},"attemptsLeft":{"type":"number"},"evidence":{"type":["object","null"],"properties":{"what":{"type":"string"},"value":{"type":"string"},"how":{"type":"string"},"on":{"type":"string"},"provider":{"type":"string"}},"required":["what","value","how","on","provider"]}},"required":["outcome","why"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/identity/address":{"get":{"operationId":"getIdentityAddress","tags":["Identity"],"summary":"G-NAF suggestions","description":"G-NAF suggestions","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/identity#get-v1-identity-address"},"parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"attribution":{"type":"string"},"suggestions":{"type":"array"},"why":{"type":"string"},"parsed":{"type":"object","properties":{"unit":{},"number":{},"street":{},"streetType":{},"suburb":{},"state":{},"postcode":{}},"required":["unit","number","street","streetType","suburb","state","postcode"]}},"required":["attribution","suggestions","why","parsed"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/identity/id/start":{"post":{"operationId":"postIdentityIdStart","tags":["Identity"],"summary":"POST /v1/identity/id/start","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/identity#post-v1-identity-id-start"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{reference, callback}","content":{"application/json":{"schema":{"type":"object","description":"{reference, callback}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"sent":{"type":"boolean"},"sessionId":{},"url":{},"why":{"type":"string"}},"required":["sent","sessionId","url","why"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/identity/id/webhook":{"post":{"operationId":"postIdentityIdWebhook","tags":["Identity"],"summary":"The provider’s signed result (X-Signature-V2, with an X-Timestamp inside five minutes)","description":"The provider’s signed result (X-Signature-V2, with an X-Timestamp inside five minutes)","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/identity#post-v1-identity-id-webhook"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"provider":{"type":"string"},"session":{"type":"string"},"reference":{"type":"string"},"status":{"type":"string"},"identityVerified":{"type":"boolean"},"needsReview":{"type":"boolean"},"checkedOn":{"type":"string"},"documentType":{},"issuingState":{},"documentExpires":{},"person":{},"checks":{"type":"object","properties":{}},"screeningHits":{}},"required":["provider","session","reference","status","identityVerified","needsReview","checkedOn","documentType","issuingState","documentExpires","person","checks","screeningHits"]},"decision":{"type":"object","properties":{"outcome":{"type":"string"},"reasons":{"type":"array","items":{"type":"string"}},"shown":{"type":"array","items":{"type":"string"}},"record":{"type":"object","properties":{"provider":{"type":"string"},"session":{"type":"string"},"reference":{"type":"string"},"status":{"type":"string"},"identityVerified":{"type":"boolean"},"needsReview":{"type":"boolean"},"checkedOn":{"type":"string"},"documentType":{},"issuingState":{},"documentExpires":{},"person":{},"checks":{"type":"object","properties":{}},"screeningHits":{}},"required":["provider","session","reference","status","identityVerified","needsReview","checkedOn","documentType","issuingState","documentExpires","person","checks","screeningHits"]}},"required":["outcome","reasons","shown","record"]}},"required":["record","decision"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/identity/decision":{"post":{"operationId":"postIdentityDecision","tags":["Identity"],"summary":"POST /v1/identity/decision","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/identity#post-v1-identity-decision"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{record, rules, asAt}","content":{"application/json":{"schema":{"type":"object","description":"{record, rules, asAt}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"outcome":{"type":"string"},"reasons":{"type":"array","items":{"type":"string"}},"shown":{"type":"array","items":{"type":"string"}},"record":{"type":["object","null"],"properties":{"provider":{"type":"string"},"session":{"type":"string"},"status":{"type":"string"},"identityVerified":{"type":"boolean"},"needsReview":{"type":"boolean"},"checkedOn":{"type":"string"},"documentType":{"type":"string"},"checks":{"type":"object","properties":{"document":{"type":"boolean"},"liveness":{"type":"boolean"}},"required":["document","liveness"]}},"required":["provider","session","status","identityVerified","needsReview","checkedOn","documentType","checks"]}},"required":["outcome","reasons","record"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/identity/record":{"post":{"operationId":"postIdentityRecord","tags":["Identity"],"summary":"POST /v1/identity/record","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/identity#post-v1-identity-record"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{applicant, contacts, identity, address, rules, asAt}","content":{"application/json":{"schema":{"type":"object","description":"{applicant, contacts, identity, address, rules, asAt}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string"},"identity":{"type":["object","null"],"properties":{"provider":{"type":"string"},"session":{"type":"string"},"reference":{},"documentType":{"type":"string"},"checkedOn":{"type":"string"},"status":{"type":"string"}},"required":["provider","session","reference","documentType","checkedOn","status"]},"decision":{"type":"object","properties":{"outcome":{"type":"string"},"reasons":{"type":"array","items":{"type":"string"}}},"required":["outcome","reasons"]},"mismatches":{"type":"array"},"items":{"type":"array","items":{"type":"object","properties":{"what":{"type":"string"},"collected":{"type":"boolean"},"verified":{"type":"boolean"},"how":{"type":["string","null"]},"on":{"type":["string","null"]},"exists":{"type":["string","null"]},"provider":{"type":"string"}},"required":["what","collected","verified","how","on"]}},"keeps":{"type":"string"},"asAt":{"type":["string","null"]},"notADecision":{"type":"string"}},"required":["kind","identity","decision","mismatches","items","keeps","asAt","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/aml":{"get":{"operationId":"getAml","tags":["AML"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/aml#get-v1-aml"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"not_a_decision":{"type":"string"},"stores":{"type":"string"},"statutory":{"type":"object","properties":{"ttrThreshold":{"type":"number"},"ttrBusinessDays":{"type":"number"},"smrBusinessDays":{"type":"number"},"smrTerrorismHours":{"type":"number"}},"required":["ttrThreshold","ttrBusinessDays","smrBusinessDays","smrTerrorismHours"]},"sources":{"type":"object","properties":{"read":{"type":"string"},"ttr":{"type":"object","properties":{"url":{"type":"string"},"quotes":{"type":"array","items":{"type":"string"}}},"required":["url","quotes"]},"smr":{"type":"object","properties":{"url":{"type":"string"},"quotes":{"type":"array","items":{"type":"string"}}},"required":["url","quotes"]},"cdd":{"type":"object","properties":{"url":{"type":"string"},"quotes":{"type":"array","items":{"type":"string"}}},"required":["url","quotes"]},"individuals":{"type":"object","properties":{"url":{"type":"string"},"quotes":{"type":"array","items":{"type":"string"}}},"required":["url","quotes"]},"initial":{"type":"object","properties":{"url":{"type":"string"},"quotes":{"type":"array","items":{"type":"string"}}},"required":["url","quotes"]},"pep":{"type":"object","properties":{"url":{"type":"string"},"quotes":{"type":"array","items":{"type":"string"}}},"required":["url","quotes"]},"riskRatings":{"type":"object","properties":{"url":{"type":"string"},"quotes":{"type":"array","items":{"type":"string"}}},"required":["url","quotes"]},"compliance":{"type":"object","properties":{"url":{"type":"string"},"quotes":{"type":"array","items":{"type":"string"}}},"required":["url","quotes"]},"transition":{"type":"object","properties":{"url":{"type":"string"},"note":{"type":"string"}},"required":["url","note"]}},"required":["read","ttr","smr","cdd","individuals","initial","pep","riskRatings","compliance","transition"]},"endpoints":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","not_a_decision","stores","statutory","sources","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/aml/cdd":{"post":{"operationId":"postAmlCdd","tags":["AML"],"summary":"POST /v1/aml/cdd","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/aml#post-v1-aml-cdd"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{cip, screening, purpose}","content":{"application/json":{"schema":{"type":"object","description":"{cip, screening, purpose}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"complete":{"type":"boolean"},"missing":{"type":"array","items":{"type":"string"}},"established":{"type":"array","items":{"type":"string"}},"consequence":{"type":"string"},"source":{"type":"array","items":{"type":"string"}}},"required":["complete","missing","established","consequence","source"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/aml/risk":{"post":{"operationId":"postAmlRisk","tags":["AML"],"summary":"POST /v1/aml/risk","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/aml#post-v1-aml-risk"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{customer, settings?}","content":{"application/json":{"schema":{"type":"object","description":"{customer, settings?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"rating":{"type":"string"},"score":{"type":"number"},"factors":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"answer":{"type":["string","null"]},"points":{"type":["number","null"]},"note":{"type":["string","null"]}},"required":["key","label","answer","points","note"]}},"complete":{"type":"boolean"},"enhanced":{},"source":{"type":"array","items":{"type":"string"}}},"required":["rating","score","factors","complete","enhanced","source"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/aml/monitor":{"post":{"operationId":"postAmlMonitor","tags":["AML"],"summary":"POST /v1/aml/monitor","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/aml#post-v1-aml-monitor"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{accounts, settings?, holidays?}","content":{"application/json":{"schema":{"type":"object","description":"{accounts, settings?, holidays?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"alerts":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"account":{"type":"string"},"statutory":{"type":"boolean"},"evidence":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"on":{"type":"string"},"amount":{"type":"number"},"method":{"type":"string"},"payer":{"type":"string"},"toAccount":{"type":"string"}},"required":["id","type","on","amount"]}},"due":{"type":"string"},"why":{"type":"string"},"source":{"type":"string"}},"required":["rule","account","evidence","why"]}},"settings":{"type":"object","properties":{"structuringFloor":{"type":"number"},"structuringCount":{"type":"number"},"structuringWindowDays":{"type":"number"},"earlyPayoutShare":{"type":"number"},"earlyPayoutWithinDays":{"type":"number"},"cashMethods":{"type":"array","items":{"type":"string"}}},"required":["structuringFloor","structuringCount","structuringWindowDays","earlyPayoutShare","earlyPayoutWithinDays","cashMethods"]},"statutory":{"type":"object","properties":{"ttrThreshold":{"type":"number"},"ttrBusinessDays":{"type":"number"},"smrBusinessDays":{"type":"number"},"smrTerrorismHours":{"type":"number"}},"required":["ttrThreshold","ttrBusinessDays","smrBusinessDays","smrTerrorismHours"]},"notADecision":{"type":"string"}},"required":["alerts","settings","statutory","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/aml/smr":{"post":{"operationId":"postAmlSmr","tags":["AML"],"summary":"POST /v1/aml/smr","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/aml#post-v1-aml-smr"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{events, asAt, holidays?}","content":{"application/json":{"schema":{"type":"object","description":"{events, asAt, holidays?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":["string","null"]},"formed":{"type":["string","null"]},"terrorism":{"type":"boolean"},"due":{"type":["string","null"]},"reportedOn":{"type":["string","null"]},"overdue":{"type":"boolean"},"trail":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"on":{"type":"string"},"by":{"type":"string"},"note":{"type":"string"},"reference":{"type":"string"}},"required":["type","on","by"]}},"problems":{"type":"array"},"rule":{"type":"string"},"tippingOff":{"type":"string"},"source":{"type":"string"}},"required":["state","formed","terrorism","due","reportedOn","overdue","trail","problems","rule","tippingOff","source"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/aml/compliance-report":{"get":{"operationId":"getAmlComplianceReport","tags":["AML"],"summary":"The reporting window","description":"The reporting window","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/aml#get-v1-aml-compliance-report"},"parameters":[{"name":"asAt","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"why":{"type":"string"}},"required":["why"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/payments":{"get":{"operationId":"getPayments","tags":["Payments"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/payments#get-v1-payments"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"not_a_decision":{"type":"string"},"stores":{"type":"string"},"sources":{"type":"object","properties":{"aba":{"type":"object","properties":{"cite":{"type":"string"},"urls":{"type":"array","items":{"type":"string"}},"read":{"type":"string"}},"required":["cite","urls","read"]},"returns":{"type":"object","properties":{"cite":{"type":"string"},"urls":{"type":"array","items":{"type":"string"}},"read":{"type":"string"}},"required":["cite","urls","read"]}},"required":["aba","returns"]},"transaction_codes":{"type":"object","additionalProperties":{"type":"string"}},"return_codes":{"type":"object","additionalProperties":{"type":"object","properties":{"says":{"type":"string"},"authorityEnded":{"type":"boolean"},"payerCancelled":{"type":"boolean"},"fix":{"type":"string"}},"required":["says","authorityEnded","payerCancelled","fix"]}},"endpoints":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","not_a_decision","stores","sources","transaction_codes","return_codes","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/credit-reporting":{"get":{"operationId":"getCreditReporting","tags":["Credit Reporting"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/credit-reporting#get-v1-credit-reporting"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"not_a_decision":{"type":"string"},"stores":{"type":"string"},"sources":{"type":"object","properties":{"rhi":{"type":"object","properties":{"cite":{"type":"string"},"url":{"type":"string"},"read":{"type":"string"}},"required":["cite","url","read"]},"fhi":{"type":"object","properties":{"cite":{"type":"string"},"url":{"type":"string"},"read":{"type":"string"}},"required":["cite","url","read"]},"default_conditions":{"type":"object","properties":{"cite":{"type":"string"},"url":{"type":"string"},"read":{"type":"string"}},"required":["cite","url","read"]},"default_notice":{"type":"object","properties":{"cite":{"type":"string"},"url":{"type":"string"},"read":{"type":"string"}},"required":["cite","url","read"]},"default_timing":{"type":"object","properties":{"cite":{"type":"string"},"url":{"type":"string"},"read":{"type":"string"}},"required":["cite","url","read"]},"who_may":{"type":"object","properties":{"cite":{"type":"string"},"url":{"type":"string"},"read":{"type":"string"}},"required":["cite","url","read"]}},"required":["rhi","fhi","default_conditions","default_notice","default_timing","who_may"]},"unverified":{"type":"array","items":{"type":"string"}},"endpoints":{"type":"object","additionalProperties":{"type":"string"}},"service_events":{"type":"object","properties":{"prepared":{"type":"string"},"checked":{"type":"string"},"approved":{"type":"string"},"submitted":{"type":"string"},"acknowledged":{"type":"string"},"rejected":{"type":"string"},"enquiry":{"type":"string"}},"required":["prepared","checked","approved","submitted","acknowledged","rejected","enquiry"]},"tiers":{"type":"object","properties":{"negative":{"type":"string"},"partial":{"type":"string"},"comprehensive":{"type":"string"}},"required":["negative","partial","comprehensive"]},"activities":{"type":"object","properties":{"enquiry":{"type":"string"},"contribution":{"type":"string"},"default":{"type":"string"}},"required":["enquiry","contribution","default"]},"enquiry_purposes":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","not_a_decision","stores","sources","unverified","endpoints","service_events","tiers","activities","enquiry_purposes"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/payments/aba":{"post":{"operationId":"postPaymentsAba","tags":["Payments"],"summary":"A BECS direct entry file, or the reasons it was refused","description":"A BECS direct entry file, or the reasons it was refused","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/payments#post-v1-payments-aba"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{header, trace, remitter, items, balance?}","content":{"application/json":{"schema":{"type":"object","description":"{header, trace, remitter, items, balance?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"file":{"type":"string"},"records":{"type":"array","items":{"type":"string"}},"totals":{"type":"object","properties":{"credits":{"type":"number"},"debits":{"type":"number"},"net":{"type":"number"},"count":{"type":"number"},"balanced":{"type":"boolean"}},"required":["credits","debits","net","count","balanced"]},"says":{"type":"string"},"problems":{"type":"array"},"sources":{"type":"object","properties":{"cite":{"type":"string"},"urls":{"type":"array","items":{"type":"string"}},"read":{"type":"string"}},"required":["cite","urls","read"]},"notADecision":{"type":"string"}},"required":["ok","file","records","totals","says","problems","sources","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/payments/debits":{"post":{"operationId":"postPaymentsDebits","tags":["Payments"],"summary":"The debits to raise on a day","description":"The debits to raise on a day","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/payments#post-v1-payments-debits"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{on, accounts: [{reference, terms, events, authority}]}","content":{"application/json":{"schema":{"type":"object","description":"{on, accounts: [{reference, terms, events, authority}]}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"on":{"type":"string"},"instructions":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"on":{"type":"string"},"amount":{"type":"number"},"rows":{"type":"array","items":{"type":"number"}},"bsb":{"type":"string"},"account":{"type":"string"},"name":{"type":"string"},"code":{"type":"number"},"evidence":{"type":"array","items":{"type":"string"}}},"required":["reference","on","amount","rows","bsb","account","name","code","evidence"]}},"skipped":{"type":"array"},"total":{"type":"number"},"says":{"type":"string"},"notADecision":{"type":"string"}},"required":["ok","on","instructions","skipped","total","says","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/payments/return":{"post":{"operationId":"postPaymentsReturn","tags":["Payments"],"summary":"A returned debit as ledger events and conduct","description":"A returned debit as ledger events and conduct","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/payments#post-v1-payments-return"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{payment, code, on}","content":{"application/json":{"schema":{"type":"object","description":"{payment, code, on}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"code":{"type":"number"},"meaning":{"type":"string"},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"reverses":{"type":"string"},"on":{"type":"string"},"reason":{"type":"string"},"reference":{"type":"string"}},"required":["id","type","reverses","on","reason","reference"]}},"conduct":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"on":{"type":"string"},"source":{"type":"string"}},"required":["type","on","source"]}},"authority":{"type":"string"},"borrowerConduct":{"type":"boolean"},"says":{"type":"string"},"source":{"type":"object","properties":{"cite":{"type":"string"},"urls":{"type":"array","items":{"type":"string"}},"read":{"type":"string"}},"required":["cite","urls","read"]},"notADecision":{"type":"string"}},"required":["ok","code","meaning","events","conduct","authority","borrowerConduct","says","source","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/payments/payto":{"post":{"operationId":"postPaymentsPayto","tags":["Payments"],"summary":"A PayTo agreement replayed","description":"A PayTo agreement replayed","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/payments#post-v1-payments-payto"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{events: [{to, on, by}]}","content":{"application/json":{"schema":{"type":"object","description":"{events: [{to, on, by}]}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string"},"history":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"on":{"type":["string","null"]},"by":{"type":"string"}},"required":["state","on","by"]}},"problems":{"type":"array"},"conduct":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"on":{"type":"string"},"source":{"type":"string"}},"required":["type","on","source"]}},"mayDebit":{"type":"boolean"},"next":{"type":"array","items":{"type":"string"}},"notADecision":{"type":"string"}},"required":["state","history","problems","conduct","mayDebit","next","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/payments/reconcile":{"post":{"operationId":"postPaymentsReconcile","tags":["Payments"],"summary":"POST /v1/payments/reconcile","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/payments#post-v1-payments-reconcile"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{expected, settled}","content":{"application/json":{"schema":{"type":"object","description":"{expected, settled}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"matched":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"amount":{"type":"number"}},"required":["reference","amount"]}},"missing":{"type":"array"},"unexpected":{"type":"array"},"mismatched":{"type":"array"},"returned":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"expected":{"type":"number"},"code":{"type":"number"},"meaning":{"type":"string"}},"required":["reference","expected","code","meaning"]}},"problems":{"type":"array"},"clean":{"type":"boolean"},"says":{"type":"string"},"notADecision":{"type":"string"}},"required":["matched","missing","unexpected","mismatched","returned","problems","clean","says","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/payments/payouts":{"post":{"operationId":"postPaymentsPayouts","tags":["Payments"],"summary":"POST /v1/payments/payouts","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/payments#post-v1-payments-payouts"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{contracts: [{reference, state, amount, payee, nameCheck}]}","content":{"application/json":{"schema":{"type":"object","description":"{contracts: [{reference, state, amount, payee, nameCheck}]}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"instructions":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"bsb":{"type":"string"},"account":{"type":"string"},"name":{"type":"string"},"amount":{"type":"number"},"code":{"type":"number"},"nameCheck":{"type":"string"},"flag":{}},"required":["reference","bsb","account","name","amount","code","nameCheck","flag"]}},"held":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"why":{"type":"string"}},"required":["reference","why"]}},"says":{"type":"string"},"notADecision":{"type":"string"}},"required":["instructions","held","says","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/credit-reporting/history":{"post":{"operationId":"postCreditReportingHistory","tags":["Credit Reporting"],"summary":"POST /v1/credit-reporting/history","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/credit-reporting#post-v1-credit-reporting-history"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{reference, terms, events, arrangements?, asAt, grace?}","content":{"application/json":{"schema":{"type":"object","description":"{reference, terms, events, arrangements?, asAt, grace?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"reference":{"type":"string"},"asAt":{"type":"string"},"grace":{"type":"number"},"months":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string"},"month":{"type":"string"},"monthEnd":{"type":"string"},"rhi":{"type":"string"},"determined":{"type":"boolean"},"basis":{"type":"string"},"daysOverdue":{"type":"number"},"oldestUnpaid":{"type":["string","null"]},"arrears":{"type":"number"},"fhi":{},"arrangement":{},"evidence":{"type":"array","items":{"type":"string"}},"inForce":{},"hardshipRequest":{}},"required":["account","month","monthEnd","rhi","determined","basis","daysOverdue","oldestUnpaid","arrears","fhi","arrangement","evidence","inForce","hardshipRequest"]}},"precondition":{"type":"object","properties":{"cite":{"type":"string"},"url":{"type":"string"},"read":{"type":"string"},"says":{"type":"string"}},"required":["cite","url","read","says"]},"sources":{"type":"array","items":{"type":"object","properties":{"cite":{"type":"string"},"url":{"type":"string"},"read":{"type":"string"}},"required":["cite","url","read"]}},"unverified":{"type":"array","items":{"type":"string"}},"pendingRequestRule":{"type":"object","properties":{"rule":{"type":"string"},"why":{"type":"string"},"confirmed":{"type":"string"},"lawyer":{"type":"string"}},"required":["rule","why","confirmed","lawyer"]},"arrangementRule":{"type":"object","properties":{"rule":{"type":"string"},"lawyer":{"type":"string"},"cite":{"type":"string"}},"required":["rule","lawyer","cite"]},"notADecision":{"type":"string"}},"required":["ok","reference","asAt","grace","months","precondition","sources","unverified","pendingRequestRule","arrangementRule","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/credit-reporting/submission":{"post":{"operationId":"postCreditReportingSubmission","tags":["Credit Reporting"],"summary":"POST /v1/credit-reporting/submission","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/credit-reporting#post-v1-credit-reporting-submission"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{month, accounts: [{reference, terms, events, arrangements}], previous?}","content":{"application/json":{"schema":{"type":"object","description":"{month, accounts: [{reference, terms, events, arrangements}], previous?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"month":{"type":"string"},"records":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"account":{"type":"string"},"month":{"type":"string"},"rhi":{"type":"string"},"fhi":{},"arrangement":{},"daysOverdue":{"type":"number"},"evidence":{"type":"array","items":{"type":"string"}}},"required":["kind","account","month","rhi","fhi","arrangement","daysOverdue","evidence"]}},"corrections":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"account":{"type":"string"},"month":{"type":"string"},"rhi":{"type":"string"},"fhi":{},"arrangement":{},"daysOverdue":{"type":"number"},"evidence":{"type":"array","items":{"type":"string"}},"was":{"type":"object","properties":{"rhi":{"type":"string"},"fhi":{},"arrangement":{},"daysOverdue":{"type":"number"}},"required":["rhi","fhi","arrangement","daysOverdue"]}},"required":["kind","account","month","rhi","fhi","arrangement","daysOverdue","evidence","was"]}},"undetermined":{"type":"array"},"refused":{"type":"array"},"says":{"type":"string"},"sources":{"type":"array","items":{"type":"object","properties":{"cite":{"type":"string"},"url":{"type":"string"},"read":{"type":"string"}},"required":["cite","url","read"]}},"unverified":{"type":"array","items":{"type":"string"}},"notADecision":{"type":"string"}},"required":["ok","month","records","corrections","undetermined","refused","says","sources","unverified","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/credit-reporting/default":{"post":{"operationId":"postCreditReportingDefault","tags":["Credit Reporting"],"summary":"POST /v1/credit-reporting/default","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/credit-reporting#post-v1-credit-reporting-default"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{terms, events, asAt, s6qNotice, s21dNotice, statuteBarred, hardshipRequest, threshold?}","content":{"application/json":{"schema":{"type":"object","description":"{terms, events, asAt, s6qNotice, s21dNotice, statuteBarred, hardshipRequest, threshold?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"account":{"type":"string"},"asAt":{"type":"string"},"daysOverdue":{"type":"number"},"overdueAmount":{"type":"number"},"conditions":{"type":"array","items":{"type":"object","properties":{"condition":{"type":"string"},"met":{"type":"boolean"},"cite":{"type":"string"},"url":{"type":"string"},"evidence":{"type":"string"}},"required":["condition","met","cite","url","evidence"]}},"allMet":{"type":"boolean"},"reported":{"type":"boolean"},"amountCeiling":{"type":"object","properties":{"amount":{"type":"number"},"says":{"type":"string"}},"required":["amount","says"]},"says":{"type":"string"},"unverified":{"type":"array","items":{"type":"string"}},"notADecision":{"type":"string"}},"required":["ok","account","asAt","daysOverdue","overdueAmount","conditions","allMet","reported","amountCeiling","says","unverified","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/credit-reporting/prepare":{"post":{"operationId":"postCreditReportingPrepare","tags":["Credit Reporting"],"summary":"The month’s contribution as it would be sent, its SHA-256, and the check before a person at the…","description":"The month’s contribution as it would be sent, its SHA-256, and the check before a person at the lender approves it","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/credit-reporting#post-v1-credit-reporting-prepare"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{month, accounts: [{reference, terms, events, arrangements}], previous?, tier?, body?}","content":{"application/json":{"schema":{"type":"object","description":"{month, accounts: [{reference, terms, events, arrangements}], previous?, tier?, body?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"body":{"type":"string"},"month":{"type":"string"},"tier":{"type":"string"},"contents":{"type":"object","properties":{"body":{"type":"string"},"month":{"type":"string"},"records":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string"},"month":{"type":"string"},"rhi":{"type":"string"},"fhi":{}},"required":["account","month","rhi","fhi"]}},"corrections":{"type":"array"}},"required":["body","month","records","corrections"]},"hash":{"type":"string"},"undetermined":{"type":"array"},"refused":{"type":"array"},"evidence":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string"},"month":{"type":"string"},"evidence":{"type":"array","items":{"type":"string"}}},"required":["account","month","evidence"]}},"says":{"type":"string"},"sources":{"type":"array","items":{"type":"object","properties":{"cite":{"type":"string"},"url":{"type":"string"},"read":{"type":"string"}},"required":["cite","url","read"]}},"notADecision":{"type":"string"},"check":{"type":"object","properties":{"clean":{"type":"boolean"},"problems":{"type":"array"},"notes":{"type":"array","items":{"type":"string"}},"hash":{"type":"string"}},"required":["clean","problems","notes","hash"]}},"required":["ok","body","month","tier","contents","hash","undetermined","refused","evidence","says","sources","notADecision","check"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/credit-reporting/obligations":{"post":{"operationId":"postCreditReportingObligations","tags":["Credit Reporting"],"summary":"The lender’s filings replayed from its own events","description":"The lender’s filings replayed from its own events: each one’s step, due day, overdue flag and approval, and its enquiry log","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/credit-reporting#post-v1-credit-reporting-obligations"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{config: {id, compliance, creditReporting}, events, asAt, defaults?}","content":{"application/json":{"schema":{"type":"object","description":"{config: {id, compliance, creditReporting}, events, asAt, defaults?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"lender":{"type":"string"},"asAt":{"type":"string"},"configured":{"type":"boolean"},"configProblems":{"type":"array"},"problems":{"type":"array"},"filings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"body":{"type":"string"},"bodyLabel":{"type":"string"},"month":{"type":["string","null"]},"account":{"type":["string","null"]},"what":{"type":"string"},"stage":{"type":"string"},"state":{"type":"string"},"correcting":{"type":"boolean"},"open":{"type":"boolean"},"overdue":{"type":"boolean"},"due":{"type":"string"},"dueWhy":{"type":"string"},"opensOn":{"type":"string"},"closesOn":{"type":["string","null"]},"submits":{"type":"string"},"approval":{"type":["object","null"],"properties":{"on":{"type":"string"},"by":{"type":"string"},"hash":{"type":"string"},"stands":{"type":"boolean"},"problems":{"type":"array"}},"required":["on","by","hash","stands","problems"]},"hash":{"type":["string","null"]},"firstSentOn":{"type":["string","null"]},"acknowledgedOn":{"type":["string","null"]},"rejections":{"type":"array","items":{"type":"object","properties":{"on":{"type":"string"},"due":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string"},"month":{"type":"string"},"reason":{"type":"string"}},"required":["account","month","reason"]}},"correctedOn":{}},"required":["on","due","items","correctedOn"]}},"steps":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"on":{"type":"string"},"by":{"type":["string","null"]}},"required":["type","on","by"]}},"flags":{"type":"array","items":{"type":"string"}}},"required":["id","kind","body","bodyLabel","month","account","what","stage","state","correcting","open","overdue","due","dueWhy","opensOn","closesOn","submits","approval","hash","firstSentOn","acknowledgedOn","rejections","steps","flags"]}},"open":{"type":"number"},"overdue":{"type":"number"},"dueNext":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"body":{"type":"string"},"bodyLabel":{"type":"string"},"month":{"type":"string"},"account":{},"what":{"type":"string"},"stage":{"type":"string"},"state":{"type":"string"},"correcting":{"type":"boolean"},"open":{"type":"boolean"},"overdue":{"type":"boolean"},"due":{"type":"string"},"dueWhy":{"type":"string"},"opensOn":{"type":"string"},"closesOn":{},"submits":{"type":"string"},"approval":{},"hash":{},"firstSentOn":{},"acknowledgedOn":{},"rejections":{"type":"array"},"steps":{"type":"array"},"flags":{"type":"array"}},"required":["id","kind","body","bodyLabel","month","account","what","stage","state","correcting","open","overdue","due","dueWhy","opensOn","closesOn","submits","approval","hash","firstSentOn","acknowledgedOn","rejections","steps","flags"]},"enquiries":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"on":{"type":"string"},"by":{"type":"string"},"body":{"type":"string"},"application":{"type":"string"},"purpose":{"type":"string"},"receipt":{"type":"string"},"outcome":{"type":"string"},"invented":{"type":"boolean"}},"required":["on","by","body","application","purpose","receipt","outcome","invented"]}},"count":{"type":"number"},"problems":{"type":"array"},"repeated":{"type":"array"},"notKept":{"type":"array"},"says":{"type":"string"}},"required":["rows","count","problems","repeated","notKept","says"]},"says":{"type":"string"},"eventTypes":{"type":"object","properties":{"prepared":{"type":"string"},"checked":{"type":"string"},"approved":{"type":"string"},"submitted":{"type":"string"},"acknowledged":{"type":"string"},"rejected":{"type":"string"},"enquiry":{"type":"string"}},"required":["prepared","checked","approved","submitted","acknowledged","rejected","enquiry"]},"notADecision":{"type":"string"}},"required":["ok","lender","asAt","configured","configProblems","problems","filings","open","overdue","dueNext","enquiries","says","eventTypes","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/complaints":{"get":{"operationId":"getComplaints","tags":["Complaints"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/complaints#get-v1-complaints"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"not_a_decision":{"type":"string"},"stores":{"type":"string"},"events":{"type":"object","additionalProperties":{"type":"string"}},"kinds":{"type":"object","additionalProperties":{"type":"object","properties":{"days":{"type":"number"},"source":{"type":"string"},"words":{"type":"string"}},"required":["days","source","words"]}},"channels":{"type":"object","additionalProperties":{"type":"number"}},"sources":{"type":"object","properties":{"complaint":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"credit_licensees":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"any_channel":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"acknowledge":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"idr_response":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"reasons":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"standard":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"default_notice":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"hardship":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"urgent":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"hardship_table":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"delay":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"five_days":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"systemic":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"record":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"data_reporting":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"},"note":{"type":"string"}},"required":["cite","quote","note"]}},"required":["complaint","credit_licensees","any_channel","acknowledge","idr_response","reasons","standard","default_notice","hardship","urgent","hardship_table","delay","five_days","systemic","record","data_reporting"]},"endpoints":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","not_a_decision","stores","events","kinds","channels","sources","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/complaints/clock":{"post":{"operationId":"postComplaintsClock","tags":["Complaints"],"summary":"One complaint replayed","description":"One complaint replayed","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/complaints#post-v1-complaints-clock"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{events, asAt, reference?}","content":{"application/json":{"schema":{"type":"object","description":"{events, asAt, reference?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"reference":{},"kind":{"type":"string"},"urgent":{"type":"boolean"},"recordedKind":{"type":"string"},"kindNote":{},"category":{"type":"string"},"channel":{"type":"string"},"spoken":{"type":"boolean"},"receivedOn":{"type":"string"},"acknowledgeBy":{"type":"string"},"acknowledgedOn":{},"responseDue":{"type":"string"},"responseDueSource":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"confirmTermsBy":{},"fifthBusinessDay":{"type":"string"},"responseRequired":{"type":"boolean"},"responseOn":{},"responseStatesAfcaRights":{},"delayNotifiedOn":{},"referredToAfcaOn":{},"closedOn":{},"daysOpen":{"type":"number"},"businessDaysOpen":{"type":"number"},"status":{"type":"string"},"overdue":{"type":"boolean"},"flags":{"type":"array","items":{"type":"string"}},"steps":{"type":"array","items":{"type":"string"}},"problems":{"type":"array"},"complainant":{},"asAt":{"type":"string"},"notADecision":{"type":"string"}},"required":["ok","reference","kind","urgent","recordedKind","kindNote","category","channel","spoken","receivedOn","acknowledgeBy","acknowledgedOn","responseDue","responseDueSource","confirmTermsBy","fifthBusinessDay","responseRequired","responseOn","responseStatesAfcaRights","delayNotifiedOn","referredToAfcaOn","closedOn","daysOpen","businessDaysOpen","status","overdue","flags","steps","problems","complainant","asAt","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/complaints/register":{"post":{"operationId":"postComplaintsRegister","tags":["Complaints"],"summary":"The register with systemic grouping","description":"The register with systemic grouping","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/complaints#post-v1-complaints-register"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{complaints: [{reference, events}], asAt, window?, threshold?}","content":{"application/json":{"schema":{"type":"object","description":"{complaints: [{reference, events}], asAt, window?, threshold?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"asAt":{"type":["string","null"]},"count":{"type":"number"},"open":{"type":"number"},"overdue":{"type":"number"},"refused":{"type":"array"},"complaints":{"type":"array","items":{"type":"object","properties":{"ok":{"type":"boolean"},"reference":{"type":"string"},"kind":{"type":"string"},"urgent":{"type":"boolean"},"recordedKind":{"type":"string"},"kindNote":{},"category":{"type":"string"},"channel":{"type":"string"},"spoken":{"type":"boolean"},"receivedOn":{"type":"string"},"acknowledgeBy":{"type":"string"},"acknowledgedOn":{"type":["string","null"]},"responseDue":{"type":"string"},"responseDueSource":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"confirmTermsBy":{},"fifthBusinessDay":{"type":"string"},"responseRequired":{"type":"boolean"},"responseOn":{},"responseStatesAfcaRights":{},"delayNotifiedOn":{},"referredToAfcaOn":{},"closedOn":{},"daysOpen":{"type":"number"},"businessDaysOpen":{"type":"number"},"status":{"type":"string"},"overdue":{"type":"boolean"},"flags":{"type":"array","items":{"type":"string"}},"steps":{"type":"array","items":{"type":"string"}},"problems":{"type":"array"},"complainant":{"type":"string"},"asAt":{"type":"string"},"notADecision":{"type":"string"},"tagged":{"type":"boolean"}},"required":["ok","reference","kind","urgent","recordedKind","kindNote","category","channel","spoken","receivedOn","acknowledgeBy","acknowledgedOn","responseDue","responseDueSource","confirmTermsBy","fifthBusinessDay","responseRequired","responseOn","responseStatesAfcaRights","delayNotifiedOn","referredToAfcaOn","closedOn","daysOpen","businessDaysOpen","status","overdue","flags","steps","problems","complainant","asAt","notADecision","tagged"]}},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"total":{"type":"number"},"open":{"type":"number"},"overdue":{"type":"number"},"inWindow":{"type":"number"},"complainantsInWindow":{"type":"number"},"references":{"type":"array","items":{"type":"string"}},"possibleSystemicIssue":{"type":"boolean"},"says":{"type":"string"}},"required":["category","total","open","overdue","inWindow","complainantsInWindow","references","possibleSystemicIssue","says"]}},"source":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"notADecision":{"type":"string"}},"required":["asAt","count","open","overdue","refused","complaints","categories","source","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/complaints/extract":{"post":{"operationId":"postComplaintsExtract","tags":["Complaints"],"summary":"The IDR data extract","description":"The IDR data extract","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/complaints#post-v1-complaints-extract"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{complaints: [{reference, events, report}], period: \"YYYY-H1\"|\"YYYY-H2\", brand}","content":{"application/json":{"schema":{"type":"object","description":"{complaints: [{reference, events, report}], period: \"YYYY-H1\"|\"YYYY-H2\", brand}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"period":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"due":{"type":"string"},"rows":{"type":"array","items":{"type":"object","properties":{"ComplaintUniqueID":{"type":"string"},"ComplaintProduct":{"type":"string"},"ComplainantType":{"type":"number"},"ComplainantGender":{"type":"number"},"ComplainantAgeGroup":{"type":"number"},"ComplainantPostcode":{"type":"string"},"ComplaintStatus":{"type":"number"},"ComplaintChannel":{"type":"number"},"DateReceived":{"type":"string"},"DateClosed":{"type":"string"},"DaysOpen":{"type":"number"},"ComplaintAboutRep":{"type":"number"},"ProductOrServiceA":{"type":"string"},"ProductOrServiceB":{"type":"string"},"ProductOrServiceC":{"type":"string"},"ComplaintIssueA":{"type":"string"},"ComplaintIssueB":{"type":"string"},"ComplaintIssueC":{"type":"string"},"ComplaintOutcomeA":{"type":"string"},"ComplaintOutcomeB":{"type":"string"},"ComplaintOutcomeC":{"type":"string"},"CompensationAmount":{"type":"number"}},"required":["ComplaintUniqueID","ComplaintProduct","ComplainantType","ComplainantGender","ComplainantAgeGroup","ComplainantPostcode","ComplaintStatus","ComplaintChannel","DateReceived","DateClosed","DaysOpen","ComplaintAboutRep","ProductOrServiceA","ProductOrServiceB","ProductOrServiceC","ComplaintIssueA","ComplaintIssueB","ComplaintIssueC","ComplaintOutcomeA","ComplaintOutcomeB","ComplaintOutcomeC","CompensationAmount"]}},"gaps":{"type":"array"},"complete":{"type":"boolean"},"csv":{"type":"string"},"says":{"type":"string"},"source":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"},"note":{"type":"string"}},"required":["cite","quote","note"]},"notADecision":{"type":"string"}},"required":["ok","period","from","to","due","rows","gaps","complete","csv","says","source","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/privacy":{"get":{"operationId":"getPrivacy","tags":["Privacy"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/privacy#get-v1-privacy"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"not_a_decision":{"type":"string"},"stores":{"type":"string"},"sources":{"type":"object","properties":{"app12_timing":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"app12_guidance":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"app12_refusal":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"app13_timing":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"s21t":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"cr_code_access":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"s21v":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"s21w":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"app11_2":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"s26wh":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"s26wk":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"s26wl":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"app1_adm":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"},"commences":{"type":"string"},"note":{"type":"string"}},"required":["cite","quote","commences","note"]}},"required":["app12_timing","app12_guidance","app12_refusal","app13_timing","s21t","cr_code_access","s21v","s21w","app11_2","s26wh","s26wk","s26wl","app1_adm"]},"endpoints":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","not_a_decision","stores","sources","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/privacy/access":{"post":{"operationId":"postPrivacyAccess","tags":["Privacy"],"summary":"POST /v1/privacy/access","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/privacy#post-v1-privacy-access"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{request: {receivedOn, kind, identityCheckedOn?, respondedOn?, refused?}, asAt}","content":{"application/json":{"schema":{"type":"object","description":"{request: {receivedOn, kind, identityCheckedOn?, respondedOn?, refused?}, asAt}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"kind":{"type":"string"},"receivedOn":{"type":"string"},"respondBy":{"type":"string"},"respondedOn":{"type":"string"},"status":{"type":"string"},"basis":{"type":"array","items":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]}},"says":{"type":"string"},"flags":{"type":"array","items":{"type":"string"}},"notADecision":{"type":"string"}},"required":["ok","kind","receivedOn","respondBy","respondedOn","status","basis","says","flags","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/privacy/correction":{"post":{"operationId":"postPrivacyCorrection","tags":["Privacy"],"summary":"POST /v1/privacy/correction","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/privacy#post-v1-privacy-correction"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{request: {receivedOn, kind, agreedInWritingUntil?, correctedOn?, noticeGivenOn?}, asAt}","content":{"application/json":{"schema":{"type":"object","description":"{request: {receivedOn, kind, agreedInWritingUntil?, correctedOn?, noticeGivenOn?}, asAt}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"kind":{"type":"string"},"receivedOn":{"type":"string"},"dealWithBy":{"type":"string"},"extendedByAgreement":{"type":"boolean"},"status":{"type":"string"},"basis":{"type":"array","items":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]}},"says":{"type":"string"},"flags":{"type":"array"},"notADecision":{"type":"string"}},"required":["ok","kind","receivedOn","dealWithBy","extendedByAgreement","status","basis","says","flags","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/privacy/register":{"post":{"operationId":"postPrivacyRegister","tags":["Privacy"],"summary":"The register checked","description":"The register checked","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/privacy#post-v1-privacy-register"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{classes: [...]}","content":{"application/json":{"schema":{"type":"object","description":"{classes: [...]}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"problems":{"type":"array"}},"required":["ok","problems"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/privacy/disposal":{"post":{"operationId":"postPrivacyDisposal","tags":["Privacy"],"summary":"What falls due","description":"What falls due","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/privacy#post-v1-privacy-disposal"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{records, classes, asAt, legalHolds?}","content":{"application/json":{"schema":{"type":"object","description":"{records, classes, asAt, legalHolds?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"asAt":{"type":"string"},"due":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"class":{"type":"string"},"disposal":{"type":"string"},"disposeOn":{"type":"string"},"from":{"type":"string"},"trigger":{"type":"string"}},"required":["id","class","disposal","disposeOn","from","trigger"]}},"later":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"class":{"type":"string"},"disposal":{"type":"string"},"disposeOn":{"type":"string"},"from":{"type":"string"},"trigger":{"type":"string"}},"required":["id","class","disposal","disposeOn","from","trigger"]}},"held":{"type":"array"},"unknown":{"type":"array"},"source":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"says":{"type":"string"},"notADecision":{"type":"string"}},"required":["ok","asAt","due","later","held","unknown","source","says","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/privacy/breach":{"post":{"operationId":"postPrivacyBreach","tags":["Privacy"],"summary":"POST /v1/privacy/breach","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/privacy#post-v1-privacy-breach"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{breach: {awareOn, assessedOn?, eligible?, ...}, asAt}","content":{"application/json":{"schema":{"type":"object","description":"{breach: {awareOn, assessedOn?, eligible?, ...}, asAt}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"awareOn":{"type":"string"},"assessBy":{"type":"string"},"assessedOn":{"type":"string"},"eligible":{"type":"boolean"},"status":{"type":"string"},"notification":{"type":"object","properties":{"believedOn":{"type":"string"},"statementOn":{"type":"string"},"commissionerOn":{"type":"string"},"individualsOn":{"type":"string"},"daysToCommissioner":{"type":"number"},"basis":{"type":"array","items":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]}}},"required":["believedOn","statementOn","commissionerOn","individualsOn","daysToCommissioner","basis"]},"flags":{"type":"array"},"basis":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"says":{"type":"string"},"notADecision":{"type":"string"}},"required":["ok","awareOn","assessBy","assessedOn","eligible","status","notification","flags","basis","says","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/privacy/automated-decisions":{"post":{"operationId":"postPrivacyAutomatedDecisions","tags":["Privacy"],"summary":"POST /v1/privacy/automated-decisions","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/privacy#post-v1-privacy-automated-decisions"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{uses: [...], decisions: [{kind, solely}], asAt}","content":{"application/json":{"schema":{"type":"object","description":"{uses: [...], decisions: [{kind, solely}], asAt}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"problems":{"type":"array"},"wording":{"type":"string"},"inForce":{"type":["boolean","null"]},"commences":{"type":"string"},"says":{"type":"string"},"source":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"},"commences":{"type":"string"},"note":{"type":"string"}},"required":["cite","quote","commences","note"]},"notADecision":{"type":"string"}},"required":["ok","problems","wording","inForce","commences","says","source","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/documents":{"get":{"operationId":"getDocuments","tags":["Documents"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/documents#get-v1-documents"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"not_a_decision":{"type":"string"},"stores":{"type":"string"},"steps":{"type":"array","items":{"type":"string"}},"sources":{"type":"object","properties":{"credit_guide":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"tmd":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"sacc_information":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"precontractual":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"key_facts_sheet":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"},"note":{"type":"string"}},"required":["cite","quote","note"]},"assessment_copy":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]}},"required":["credit_guide","tmd","sacc_information","precontractual","key_facts_sheet","assessment_copy"]},"endpoints":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","not_a_decision","stores","steps","sources","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/documents/register":{"post":{"operationId":"postDocumentsRegister","tags":["Documents"],"summary":"What the product must give, and before which step","description":"What the product must give, and before which step","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/documents#post-v1-documents-register"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{product, context?}","content":{"application/json":{"schema":{"type":"object","description":"{product, context?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"product":{"type":["string","null"]},"version":{"type":["string","null"]},"documents":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"title":{"type":"string"},"applies":{"type":"boolean"},"gates":{"type":["string","null"]},"public":{"type":"boolean"},"lawStep":{"type":"string"},"cite":{"type":"string"},"quote":{"type":"string"},"note":{"type":"string"}},"required":["key","title","applies","gates","public","lawStep","cite","quote"]}},"notADecision":{"type":"string"}},"required":["product","version","documents","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/documents/version":{"post":{"operationId":"postDocumentsVersion","tags":["Documents"],"summary":"Checked for placeholders and hashed","description":"Checked for placeholders and hashed","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/documents#post-v1-documents-version"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{doc: {key, version, effectiveFrom, text}}","content":{"application/json":{"schema":{"type":"object","description":"{doc: {key, version, effectiveFrom, text}}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"key":{"type":"string"},"version":{"type":"string"},"effectiveFrom":{"type":"string"},"retiredOn":{},"sha256":{"type":"string"}},"required":["ok","key","version","effectiveFrom","retiredOn","sha256"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/documents/check":{"post":{"operationId":"postDocumentsCheck","tags":["Documents"],"summary":"Whether a document may be issued","description":"Whether a document may be issued: a credit guide missing an item s 126 requires may not","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/documents#post-v1-documents-check"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{doc}","content":{"application/json":{"schema":{"type":"object","description":"{doc}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"problems":{"type":"array"}},"required":["ok","problems"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/documents/proceed":{"post":{"operationId":"postDocumentsProceed","tags":["Documents"],"summary":"POST /v1/documents/proceed","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/documents#post-v1-documents-proceed"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{step, given: [{key, version, sha256, givenOn}], product, context?, library?, onDay?}","content":{"application/json":{"schema":{"type":"object","description":"{step, given: [{key, version, sha256, givenOn}], product, context?, library?, onDay?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"step":{"type":"string"},"missing":{"type":"array"},"problems":{"type":"array"},"says":{"type":"string"},"notADecision":{"type":"string"}},"required":["ok","step","missing","problems","says","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/documents/assessment-copy":{"post":{"operationId":"postDocumentsAssessmentCopy","tags":["Documents"],"summary":"POST /v1/documents/assessment-copy","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/documents#post-v1-documents-assessment-copy"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{requestedOn, creditDay?}","content":{"application/json":{"schema":{"type":"object","description":"{requestedOn, creditDay?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"due":{"type":["string","null"]},"businessDays":{"type":"number"},"cite":{"type":"string"},"quote":{"type":"string"},"free":{"type":"string"},"says":{"type":"string"}},"required":["ok","due","says"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/apply":{"get":{"operationId":"getApply","tags":["Apply"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/apply#get-v1-apply"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"not_a_decision":{"type":"string"},"stores":{"type":"string"},"kinds":{"type":"object","properties":{"sacc":{"type":"object","properties":{"label":{"type":"string"},"regulated":{"type":"boolean"}},"required":["label","regulated"]},"macc":{"type":"object","properties":{"label":{"type":"string"},"regulated":{"type":"boolean"}},"required":["label","regulated"]},"personal":{"type":"object","properties":{"label":{"type":"string"},"regulated":{"type":"boolean"}},"required":["label","regulated"]},"car":{"type":"object","properties":{"label":{"type":"string"},"regulated":{"type":"boolean"}},"required":["label","regulated"]},"mortgage":{"type":"object","properties":{"label":{"type":"string"},"regulated":{"type":"boolean"}},"required":["label","regulated"]},"business":{"type":"object","properties":{"label":{"type":"string"},"regulated":{"type":"boolean"}},"required":["label","regulated"]}},"required":["sacc","macc","personal","car","mortgage","business"]},"topics":{"type":"object","properties":{"purpose":{"type":"object","properties":{"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"requiredFor":{"type":"array","items":{"type":"string"}},"why":{"type":"string"}},"required":["label","part","cite","requiredFor","why"]},"amount":{"type":"object","properties":{"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"requiredFor":{"type":"array","items":{"type":"string"}},"why":{"type":"string"}},"required":["label","part","cite","requiredFor","why"]},"term":{"type":"object","properties":{"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"requiredFor":{"type":"array","items":{"type":"string"}},"why":{"type":"string"}},"required":["label","part","cite","requiredFor","why"]},"features":{"type":"object","properties":{"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"requiredFor":{"type":"array","items":{"type":"string"}},"why":{"type":"string"}},"required":["label","part","cite","requiredFor","why"]},"income":{"type":"object","properties":{"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"requiredFor":{"type":"array","items":{"type":"string"}},"why":{"type":"string"}},"required":["label","part","cite","requiredFor","why"]},"employment":{"type":"object","properties":{"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"requiredFor":{"type":"array","items":{"type":"string"}},"why":{"type":"string"}},"required":["label","part","cite","requiredFor","why"]},"housing":{"type":"object","properties":{"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"requiredFor":{"type":"array","items":{"type":"string"}},"why":{"type":"string"}},"required":["label","part","cite","requiredFor","why"]},"living_expenses":{"type":"object","properties":{"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"requiredFor":{"type":"array","items":{"type":"string"}},"why":{"type":"string"}},"required":["label","part","cite","requiredFor","why"]},"existing_credit":{"type":"object","properties":{"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"requiredFor":{"type":"array","items":{"type":"string"}},"why":{"type":"string"}},"required":["label","part","cite","requiredFor","why"]},"other_commitments":{"type":"object","properties":{"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"requiredFor":{"type":"array","items":{"type":"string"}},"why":{"type":"string"}},"required":["label","part","cite","requiredFor","why"]},"household":{"type":"object","properties":{"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"requiredFor":{"type":"array","items":{"type":"string"}},"why":{"type":"string"}},"required":["label","part","cite","requiredFor","why"]},"assets":{"type":"object","properties":{"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"requiredFor":{"type":"array","items":{"type":"string"}},"why":{"type":"string"}},"required":["label","part","cite","requiredFor","why"]},"foreseeable_changes":{"type":"object","properties":{"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"requiredFor":{"type":"array","items":{"type":"string"}},"why":{"type":"string"}},"required":["label","part","cite","requiredFor","why"]},"other_small_amount":{"type":"object","properties":{"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"requiredFor":{"type":"array"},"why":{"type":"string"}},"required":["label","part","cite","requiredFor","why"]}},"required":["purpose","amount","term","features","income","employment","housing","living_expenses","existing_credit","other_commitments","household","assets","foreseeable_changes","other_small_amount"]},"questions":{"type":"number"},"endpoints":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","not_a_decision","stores","kinds","topics","questions","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/apply/form":{"get":{"operationId":"getApplyForm","tags":["Apply"],"summary":"The standard form for a kind of credit, and its coverage","description":"The standard form for a kind of credit, and its coverage","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/apply#get-v1-apply-form"},"parameters":[{"name":"kind","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"form":{"type":"object","properties":{"key":{"type":"string"},"version":{"type":"string"},"kind":{"type":"string"},"title":{"type":"string"},"questions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"topic":{"type":["string","null"]},"type":{"type":"string"},"canonical":{"type":"string"},"text":{"type":"string"},"rules":{"type":"object","properties":{"options":{"type":"array","items":{"type":"string"}},"maxLength":{"type":"number"},"exclusiveMinimum":{"type":"number"},"integer":{"type":"boolean"},"minimum":{"type":"number"},"maximum":{"type":"number"}}},"required":{"type":"boolean"},"requiredWhen":{"type":"object","properties":{"key":{"type":"string"},"equals":{"type":["string","boolean"]}},"required":["key","equals"]},"help":{"type":"string"},"classification":{"type":"string"}},"required":["key","topic","type","canonical","text","required"]}}},"required":["key","version","kind","title","questions"]},"coverage":{"type":"object","properties":{"ok":{"type":"boolean"},"kind":{"type":"string"},"regulated":{"type":"boolean"},"topics":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string"},"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"required":{"type":"boolean"},"recommended":{"type":"boolean"},"basis":{"type":"object","properties":{"guidance":{"type":["string","null"]},"firmness":{"type":"string"}},"required":["guidance","firmness"]},"questions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"text":{"type":"string"},"required":{"type":"boolean"},"conditional":{"type":"boolean"}},"required":["key","text","required","conditional"]}},"covered":{"type":"boolean"},"weak":{"type":"boolean"}},"required":["topic","label","part","cite","required","recommended","basis","questions","covered","weak"]}},"uncovered":{"type":"array"},"weak":{"type":"array"},"recommendedMissing":{"type":"array"},"notInquiries":{"type":"array","items":{"type":"string"}},"unknownTopic":{"type":"array"},"says":{"type":"string"}},"required":["ok","kind","regulated","topics","uncovered","weak","recommendedMissing","notInquiries","unknownTopic","says"]}},"required":["form","coverage"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/apply/customise":{"post":{"operationId":"postApplyCustomise","tags":["Apply"],"summary":"A lender’s form from a base","description":"A lender’s form from a base","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/apply#post-v1-apply-customise"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{kind | form, add?, remove?, modify?, version, key?}","content":{"application/json":{"schema":{"type":"object","description":"{kind | form, add?, remove?, modify?, version, key?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"form":{"type":"object","properties":{"key":{"type":"string"},"version":{"type":"string"},"kind":{"type":"string"},"title":{"type":"string"},"questions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"topic":{"type":["string","null"]},"type":{"type":"string"},"canonical":{"type":"string"},"text":{"type":"string"},"rules":{"type":"object","properties":{"options":{"type":"array","items":{"type":"string"}},"maxLength":{"type":"number"},"exclusiveMinimum":{"type":"number"},"integer":{"type":"boolean"},"minimum":{"type":"number"},"maximum":{"type":"number"}}},"required":{"type":"boolean"},"requiredWhen":{"type":"object","properties":{"key":{"type":"string"},"equals":{"type":"string"}},"required":["key","equals"]},"help":{"type":"string"},"classification":{"type":"string"}},"required":["key","topic","type","canonical","text","required"]}},"basedOn":{"type":"object","properties":{"key":{"type":"string"},"version":{"type":"string"}},"required":["key","version"]}},"required":["key","version","kind","title","questions","basedOn"]},"changes":{"type":"array","items":{"type":"object","properties":{"change":{"type":"string"},"key":{"type":"string"},"topic":{"type":"string"},"before":{"type":"string"}},"required":["change","key","topic","before"]}},"problems":{"type":"array"},"coverage":{"type":"object","properties":{"ok":{"type":"boolean"},"kind":{"type":"string"},"regulated":{"type":"boolean"},"topics":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string"},"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"required":{"type":"boolean"},"recommended":{"type":"boolean"},"basis":{"type":"object","properties":{"guidance":{"type":["string","null"]},"firmness":{"type":"string"}},"required":["guidance","firmness"]},"questions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"text":{"type":"string"},"required":{"type":"boolean"},"conditional":{"type":"boolean"}},"required":["key","text","required","conditional"]}},"covered":{"type":"boolean"},"weak":{"type":"boolean"}},"required":["topic","label","part","cite","required","recommended","basis","questions","covered","weak"]}},"uncovered":{"type":"array","items":{"type":"string"}},"weak":{"type":"array"},"recommendedMissing":{"type":"array"},"notInquiries":{"type":"array","items":{"type":"string"}},"unknownTopic":{"type":"array"},"says":{"type":"string"}},"required":["ok","kind","regulated","topics","uncovered","weak","recommendedMissing","notInquiries","unknownTopic","says"]}},"required":["ok","form","changes","problems","coverage"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/apply/coverage":{"post":{"operationId":"postApplyCoverage","tags":["Apply"],"summary":"Which topics the form covers, and which required ones it does not","description":"Which topics the form covers, and which required ones it does not","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/apply#post-v1-apply-coverage"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{form, kind}","content":{"application/json":{"schema":{"type":"object","description":"{form, kind}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"kind":{"type":"string"},"regulated":{"type":"boolean"},"topics":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string"},"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"required":{"type":"boolean"},"recommended":{"type":"boolean"},"basis":{"type":"object","properties":{"guidance":{"type":["string","null"]},"firmness":{"type":"string"}},"required":["guidance","firmness"]},"questions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"text":{"type":"string"},"required":{"type":"boolean"},"conditional":{"type":"boolean"}},"required":["key","text","required","conditional"]}},"covered":{"type":"boolean"},"weak":{"type":"boolean"}},"required":["topic","label","part","cite","required","recommended","basis","questions","covered","weak"]}},"uncovered":{"type":"array","items":{"type":"string"}},"weak":{"type":"array"},"recommendedMissing":{"type":"array","items":{"type":"string"}},"notInquiries":{"type":"array"},"unknownTopic":{"type":"array"},"says":{"type":"string"}},"required":["ok","kind","regulated","topics","uncovered","weak","recommendedMissing","notInquiries","unknownTopic","says"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/apply/publish":{"post":{"operationId":"postApplyPublish","tags":["Apply"],"summary":"Refused while a required topic is unasked without an approved exception","description":"Refused while a required topic is unasked without an approved exception","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/apply#post-v1-apply-publish"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{form, kind, on, exceptions?, approvers?}","content":{"application/json":{"schema":{"type":"object","description":"{form, kind, on, exceptions?, approvers?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"published":{"type":"object","properties":{"form":{"type":"object","properties":{"key":{"type":"string"},"version":{"type":"string"},"hash":{"type":"string"}},"required":["key","version","hash"]},"kind":{"type":"string"},"on":{"type":"string"},"exceptions":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string"},"reason":{"type":"string"},"requestedBy":{"type":"string"},"requestedOn":{"type":"string"},"approvedBy":{"type":"string"},"approvedOn":{"type":"string"}},"required":["topic","reason","requestedBy","requestedOn","approvedBy","approvedOn"]}},"weak":{"type":"array"},"hash":{"type":"string"}},"required":["form","kind","on","exceptions","weak","hash"]},"coverage":{"type":"object","properties":{"ok":{"type":"boolean"},"kind":{"type":"string"},"regulated":{"type":"boolean"},"topics":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string"},"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"required":{"type":"boolean"},"recommended":{"type":"boolean"},"basis":{"type":"object","properties":{"guidance":{"type":["string","null"]},"firmness":{"type":"string"}},"required":["guidance","firmness"]},"questions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"text":{"type":"string"},"required":{"type":"boolean"},"conditional":{"type":"boolean"}},"required":["key","text","required","conditional"]}},"covered":{"type":"boolean"},"weak":{"type":"boolean"}},"required":["topic","label","part","cite","required","recommended","basis","questions","covered","weak"]}},"uncovered":{"type":"array","items":{"type":"string"}},"weak":{"type":"array"},"recommendedMissing":{"type":"array","items":{"type":"string"}},"notInquiries":{"type":"array"},"unknownTopic":{"type":"array"},"says":{"type":"string"}},"required":["ok","kind","regulated","topics","uncovered","weak","recommendedMissing","notInquiries","unknownTopic","says"]},"notes":{"type":"array"}},"required":["ok","published","coverage","notes"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/apply/record":{"post":{"operationId":"postApplyRecord","tags":["Apply"],"summary":"The sealed reasonable inquiries record","description":"The sealed reasonable inquiries record","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/apply#post-v1-apply-record"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{form | kind, kind, answers, submittedAt?, channel?, reference?, published?, transactions? | reading?}","content":{"application/json":{"schema":{"type":"object","description":"{form | kind, kind, answers, submittedAt?, channel?, reference?, published?, transactions? | reading?}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"record":{"type":"object","properties":{"kind":{"type":"string"},"version":{"type":"string"},"credit":{"type":"string"},"form":{"type":"object","properties":{"key":{"type":"string"},"version":{"type":"string"},"hash":{"type":"string"},"publishedOn":{},"publication":{}},"required":["key","version","hash","publishedOn","publication"]},"submission":{"type":"object","properties":{"hash":{"type":"string"},"submittedAt":{"type":"string"},"channel":{},"reference":{}},"required":["hash","submittedAt","channel","reference"]},"topics":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string"},"label":{"type":"string"},"part":{"type":"string"},"cite":{"type":"string"},"basis":{"type":"object","properties":{"guidance":{"type":"string"},"firmness":{"type":"string"}},"required":["guidance","firmness"]},"required":{"type":"boolean"},"status":{"type":"string"},"questions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"asked":{"type":"string"},"answer":{"type":["string","number","boolean","null"]},"answered":{"type":"boolean"},"applies":{"type":"boolean"},"restricted":{"type":"boolean"},"why":{"type":"string"}},"required":["key","asked","answer","answered","applies","restricted"]}},"exception":{}},"required":["topic","label","part","cite","basis","required","status","questions","exception"]}},"declaredBesideObserved":{"type":"object","properties":{"read":{"type":"boolean"},"period":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"days":{"type":"number"},"months":{"type":"number"}},"required":["from","to","days","months"]},"rows":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string"},"what":{"type":"string"},"declared":{"type":"number"},"observed":{"type":"number"},"difference":{"type":"number"},"direction":{"type":"string"},"observedFrom":{"type":"string"},"says":{"type":"string"}},"required":["topic","what","declared","observed","difference","direction","observedFrom","says"]}},"categorisedShare":{"type":"number"},"coverageNote":{}},"required":["read","period","rows","categorisedShare","coverageNote"]},"declaredPosition":{"type":"object","properties":{"monthlyIncome":{"type":"number"},"outgoings":{"type":"number"},"residual":{"type":"number"},"flags":{"type":"array","items":{"type":"string"}},"gaps":{"type":"array"}},"required":["monthlyIncome","outgoings","residual","flags","gaps"]},"codeApplies":{"type":"object","properties":{"applies":{"type":"boolean"},"says":{"type":"string"}},"required":["applies","says"]},"gaps":{"type":"array","items":{"type":"string"}}},"required":["kind","version","credit","form","submission","topics","declaredBesideObserved","declaredPosition","codeApplies","gaps"]},"hash":{"type":"string"},"feeds":{"type":"object","properties":{"decisioning":{"type":"object","properties":{"answers":{"type":"object","properties":{"purpose":{"type":"object","properties":{"value":{"type":"string"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"for_business":{"type":"object","properties":{"value":{"type":"boolean"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"requested_amount":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"requested_amount_reason":{"type":"object","properties":{"value":{"type":"string"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"requested_term_months":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"repayment_frequency":{"type":"object","properties":{"value":{"type":"string"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"expects_early_repayment":{"type":"object","properties":{"value":{"type":"boolean"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"features_needed":{"type":"object","properties":{"value":{"type":"string"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"income_amount":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"income_frequency":{"type":"object","properties":{"value":{"type":"string"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"income_source":{"type":"object","properties":{"value":{"type":"string"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"other_income_monthly":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"employment_status":{"type":"object","properties":{"value":{"type":"string"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"employment_months":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"housing_situation":{"type":"object","properties":{"value":{"type":"string"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"housing_cost_monthly":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"expense_groceries":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"expense_utilities":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"expense_transport":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"expense_insurance":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"expense_health":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"expense_education":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"expense_telco":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"expense_other":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"gambling_last_30_days":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"credit_repayments_monthly":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"credit_card_limits":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"overdue_now":{"type":"object","properties":{"value":{"type":"boolean"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"default_or_collection":{"type":"object","properties":{"value":{"type":"boolean"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"child_support_monthly":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"other_commitments_monthly":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"household":{"type":"object","properties":{"value":{"type":"string"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"dependants":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"foreseeable_change":{"type":"object","properties":{"value":{"type":"boolean"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"foreseeable_change_detail":{"type":"object","properties":{"value":{"type":"string"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"foreseeable_change_monthly":{"type":"object","properties":{"value":{"type":"number"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]},"declared_true_and_complete":{"type":"object","properties":{"value":{"type":"boolean"},"from":{"type":"string"},"at":{"type":"string"}},"required":["value","from","at"]}},"required":["purpose","for_business","requested_amount","requested_amount_reason","requested_term_months","repayment_frequency","expects_early_repayment","features_needed","income_amount","income_frequency","income_source","other_income_monthly","employment_status","employment_months","housing_situation","housing_cost_monthly","expense_groceries","expense_utilities","expense_transport","expense_insurance","expense_health","expense_education","expense_telco","expense_other","gambling_last_30_days","credit_repayments_monthly","credit_card_limits","overdue_now","default_or_collection","child_support_monthly","other_commitments_monthly","household","dependants","foreseeable_change","foreseeable_change_detail","foreseeable_change_monthly","declared_true_and_complete"]},"expenses":{"type":"object","properties":{"declared":{"type":"number"},"benchmark":{},"excludes":{"type":"string"}},"required":["declared","benchmark","excludes"]}},"required":["answers","expenses"]},"intent":{"type":"object","properties":{"income":{"type":"object","properties":{"supplied":{"type":"boolean"},"declared":{"type":"object","properties":{"monthly":{"type":"number"},"statedSource":{"type":"string"},"verified":{"type":"boolean"},"basis":{"type":"string"}},"required":["monthly","statedSource","verified","basis"]},"verified":{"type":"object","properties":{"monthly":{"type":"number"},"credits":{"type":"array","items":{"type":"object","properties":{"payer":{"type":"string"},"amount":{"type":"number"},"cadence":{"type":"string"},"monthly":{"type":"number"},"payments":{"type":"number"},"first":{"type":"string"},"last":{"type":"string"},"payerNamed":{"type":"boolean"},"transactions":{"type":"array","items":{"type":"string"}}},"required":["payer","amount","cadence","monthly","payments","first","last","payerNamed","transactions"]}}},"required":["monthly","credits"]},"difference":{"type":"number"},"shareOfVerified":{"type":"number"},"direction":{"type":"string"},"statement":{"type":"string"},"notAConclusion":{"type":"string"},"explanations":{"type":"array","items":{"type":"string"}},"otherCreditsMonthly":{"type":"number"},"differenceCountingOtherCredits":{"type":"number"}},"required":["supplied","declared","verified","difference","shareOfVerified","direction","statement","notAConclusion","explanations","otherCreditsMonthly","differenceCountingOtherCredits"]},"debts":{"type":"object","properties":{"declared":{"type":"number"},"observed":{"type":"number"}},"required":["declared","observed"]}},"required":["income","debts"]},"compliance":{"type":"array","items":{"type":"object","properties":{"obligation":{"type":"string"},"cite":{"type":"string"},"evidence":{"type":"string"},"asked":{"type":["number","null"]},"of":{"type":["number","null"]},"unasked":{"type":"array"}},"required":["obligation","cite","evidence","asked","of","unasked"]}}},"required":["decisioning","intent","compliance"]},"declaredPosition":{"type":"object","properties":{"version":{"type":"string"},"kind":{"type":"string"},"monthlyIncome":{"type":"number"},"livingCosts":{"type":"number"},"gambling":{"type":"number"},"creditRepayments":{"type":"number"},"otherCommitments":{"type":"number"},"outgoings":{"type":"number"},"residual":{"type":"number"},"ratios":{"type":"object","properties":{"gambling":{"type":"number"},"credit":{"type":"number"},"outgoings":{"type":"number"}},"required":["gambling","credit","outgoings"]},"flags":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"says":{"type":"string"}},"required":["code","says"]}},"gaps":{"type":"array"},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"}},"required":["step","what","amount","rule"]}},"says":{"type":"string"}},"required":["version","kind","monthlyIncome","livingCosts","gambling","creditRepayments","otherCommitments","outgoings","residual","ratios","flags","gaps","lines","says"]},"says":{"type":"string"},"notADecision":{"type":"string"}},"required":["ok","record","hash","feeds","declaredPosition","says","notADecision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/score":{"get":{"operationId":"getScore","tags":["Score"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/score#get-v1-score"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"stores":{"type":"string"},"says":{"type":"string"},"scales":{"type":"object","properties":{"elo":{"type":"string"},"plain":{"type":"string"}},"required":["elo","plain"]},"riskClasses":{"type":"object","properties":{"says":{"type":"string"},"elo":{"type":"array","items":{"type":"object","properties":{"riskClass":{"type":"string"},"pd":{"type":"object","properties":{"from":{"type":"number"},"to":{"type":"number"}},"required":["from","to"]},"says":{"type":"string"}},"required":["riskClass","pd","says"]}},"plain":{"type":"object","properties":{"says":{"type":"string"},"classes":{"type":"array","items":{"type":"object","properties":{"riskClass":{"type":"string"},"points":{"type":"object","properties":{"from":{"type":"number"},"to":{"type":"number"}},"required":["from","to"]},"says":{"type":"string"}},"required":["riskClass","points","says"]}}},"required":["says","classes"]},"loans":{"type":"object","properties":{"riskClass":{"type":"string"},"says":{"type":"string"}},"required":["riskClass","says"]},"notches":{"type":"string"}},"required":["says","elo","plain","loans","notches"]},"keeps":{"type":"string"},"endpoints":{"type":"object","additionalProperties":{"type":"object","properties":{"what":{"type":"string"},"body":{"type":"string"}},"required":["what","body"]}}},"required":["service","version","stores","says","scales","riskClasses","keeps","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]},"post":{"operationId":"postScore","tags":["Score"],"summary":"Score an applicant against the lender’s model borrower, or on the plain scale out of 1200, with its…","description":"Score an applicant against the lender’s model borrower, or on the plain scale out of 1200, with its risk class (AAA to CC) and, on the rating, the chance it is not repaid in full. The answer carries the first entry of the rating history, to keep.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/score#post-v1-score"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{ statement (CSV text) | application (reading, assessment, history, answers…), amount, termMonths, frequency, scale: elo | plain, model? (the model borrower, as /v1/score/model-borrower returned it), lender?, reference? (the application’s), loan? }","content":{"application/json":{"schema":{"type":"object","description":"{ statement (CSV text) | application (reading, assessment, history, answers…), amount, termMonths, frequency, scale: elo | plain, model? (the model borrower, as /v1/score/model-borrower returned it), lender?, reference? (the application’s), loan? }"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"request":{"type":"object","properties":{"amount":{"type":"number"},"termMonths":{"type":"number"},"frequency":{"type":"string"},"product":{"type":"string"}},"required":["amount","termMonths","frequency","product"]},"score":{"type":"object","properties":{"version":{"type":"string"},"scale":{"type":"string"},"components":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"weight":{"type":"number"},"result":{"type":["number","null"]},"matches":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"better":{"type":"string"},"format":{"type":"string"},"value":{"type":["number","null"]},"result":{"type":["number","null"]},"middle":{"type":["number","null"]},"missing":{"type":["string","null"]},"scale":{"type":"array","items":{"type":"array","items":{"type":"number"}}}},"required":["key","label","better","format","value","result","middle","missing"]}}},"required":["key","label","weight","result","matches"]}},"measures":{"type":"object","properties":{"surplus_share":{"type":"number"},"repayment_share":{"type":"number"},"earnings_headroom":{"type":"number"},"income_credits":{"type":"number"},"income_spread":{"type":"number"},"inferred_share":{"type":"number"},"dishonours":{"type":"number"},"commitment_share":{"type":"number"},"credit_signals":{"type":"number"},"categorised_share":{"type":"number"}},"required":["surplus_share","repayment_share","earnings_headroom","income_credits","income_spread","inferred_share","dishonours","commitment_share","credit_signals","categorised_share"]},"model":{"type":["object","null"],"properties":{"name":{"type":"string"},"rating":{"type":"number"},"start":{"type":"number"},"source":{"type":"string"},"n":{"type":"number"},"lenderWeight":{"type":"number"},"from":{},"to":{}},"required":["name","rating","start","source","n","lenderWeight","from","to"]},"benchmark":{"type":["object","null"],"properties":{"source":{"type":"string"},"n":{"type":"number"},"lenderWeight":{"type":"number"},"about":{"type":"string"}},"required":["source","n","lenderWeight","about"]},"mode":{"type":"string"},"notADecision":{"type":"string"},"excluded":{"type":"array","items":{"type":"string"}},"scored":{"type":"boolean"},"rating":{"type":"number"},"riskClass":{"type":"string"},"riskClassNotch":{"type":["string","null"]},"pd":{"type":["number","null"]},"says":{"type":"string"},"expected":{"type":"number"},"difference":{"type":"number"},"anchor":{"type":"number"},"coverage":{"type":"number"},"calibrated":{"type":"boolean"},"out":{"type":"number"},"share":{"type":"number"}},"required":["version","scale","components","measures","model","benchmark","mode","notADecision","excluded","scored","rating","riskClass","riskClassNotch","pd","says","coverage","calibrated"]},"suggestion":{"type":"object","properties":{"suggestion":{"type":"string"},"says":{"type":"string"},"amount":{"type":"number"},"termMonths":{"type":"number"},"frequency":{"type":"string"},"repayment":{"type":"number"},"repayments":{"type":"number"},"total":{"type":"number"},"surplusAfter":{"type":"number"},"surplusBefore":{"type":"number"},"loading":{"type":"number"},"riskClass":{"type":"string"},"reasons":{"type":"array"},"notADecision":{"type":"string"}},"required":["suggestion","says","amount","termMonths","frequency","repayment","repayments","total","surplusAfter","surplusBefore","loading","riskClass","reasons","notADecision"]},"period":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"days":{"type":"number"},"months":{"type":"number"}},"required":["from","to","days","months"]},"entry":{"type":"object","properties":{"key":{"type":"string"},"reason":{"type":"string"},"application":{"type":["string","null"]},"loan":{"type":["string","null"]},"on":{"type":"string"},"scale":{"type":"string"},"version":{"type":"string"},"scored":{"type":"boolean"},"why":{},"before":{},"after":{"type":"number"},"change":{},"rating":{"type":"number"},"riskClass":{"type":"string"},"riskClassNotch":{"type":["string","null"]},"pd":{"type":["number","null"]},"calibrated":{"type":"boolean"},"says":{"type":"string"},"model":{"type":["object","null"],"properties":{"name":{"type":"string"},"rating":{"type":"number"},"start":{"type":"number"},"source":{"type":"string"},"n":{"type":"number"},"lenderWeight":{"type":"number"},"from":{},"to":{}},"required":["name","rating","start","source","n","lenderWeight","from","to"]},"against":{"type":"string"},"difference":{"type":["number","null"]},"expected":{"type":["number","null"]},"repays":{"type":["number","null"]},"coverage":{"type":"number"},"comparison":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"component":{"type":"string"},"label":{"type":"string"},"better":{"type":"string"},"format":{"type":"string"},"value":{"type":["number","null"]},"model":{"type":"number"},"result":{"type":["number","null"]},"direction":{"type":["string","null"]},"by":{"type":["number","null"]},"says":{"type":"string"},"points":{"type":["number","null"]},"scale":{"type":"array","items":{"type":"array","items":{"type":"number"}}}},"required":["key","component","label","better","format","value","says"]}},"components":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"weight":{"type":"number"},"result":{"type":["number","null"]}},"required":["key","label","weight","result"]}},"measures":{"type":"object","properties":{"surplus_share":{"type":"number"},"repayment_share":{"type":"number"},"earnings_headroom":{"type":"number"},"income_credits":{"type":"number"},"income_spread":{"type":"number"},"inferred_share":{"type":"number"},"dishonours":{"type":"number"},"commitment_share":{"type":"number"},"credit_signals":{"type":"number"},"categorised_share":{"type":"number"}},"required":["surplus_share","repayment_share","earnings_headroom","income_credits","income_spread","inferred_share","dishonours","commitment_share","credit_signals","categorised_share"]},"dishonoursAndDefaults":{}},"required":["key","reason","application","loan","on","scale","version","scored","why","before","after","change","rating","riskClass","riskClassNotch","pd","calibrated","says","model","against","difference","expected","repays","coverage","comparison","components","measures","dishonoursAndDefaults"]}},"required":["ok","request","score","suggestion","period","entry"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/score/model-borrower":{"post":{"operationId":"postScoreModelBorrower","tags":["Score"],"summary":"Count completed and written-off loans in the lender’s model borrower, up to 25 a call","description":"Count completed and written-off loans in the lender’s model borrower, up to 25 a call: its rating moves with each, and repaid loans join its profile. A write-off with hardship relief is a loss, counted apart. Send it back each time; each loan counts once.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/score#post-v1-score-model-borrower"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{ model? | lender, loans: [{ loan, application?, outcome: completed | written off | written off with hardship relief, on, good: repaid and never over 7 days past due, rated: the history’s first entry (scale, rating, measures) }] }","content":{"application/json":{"schema":{"type":"object","description":"{ model? | lender, loans: [{ loan, application?, outcome: completed | written off | written off with hardship relief, on, good: repaid and never over 7 days past due, rated: the history’s first entry (scale, rating, measures) }] }"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"model":{"type":"object","properties":{"kind":{"type":"string"},"version":{"type":"string"},"scoreVersion":{"type":"string"},"lender":{"type":["string","null"]},"name":{"type":"string"},"rating":{"type":"number"},"start":{"type":"number"},"k":{"type":"number"},"repaidAt1500":{"type":"number"},"games":{"type":"number"},"completed":{"type":"number"},"writtenOff":{"type":"number"},"writtenOffWithHardshipRelief":{"type":"number"},"counted":{"type":"number"},"lastSeq":{"type":"number"},"since":{},"updatedOn":{"type":["string","null"]},"window":{"type":"object","properties":{"months":{"type":"number"},"most":{"type":"number"},"keys":{"type":"array","items":{"type":"string"}},"loans":{"type":"array","items":{"type":"object","properties":{"loan":{"type":"string"},"on":{"type":"string"},"m":{"type":"array","items":{"type":["number","null"]}}},"required":["loan","on","m"]}},"recent":{"type":"array","items":{"type":"string"}}},"required":["months","most","keys","loans","recent"]},"profile":{"type":"object","properties":{"source":{"type":"string"},"n":{"type":"number"},"lenderWeight":{"type":"number"},"from":{"type":["string","null"]},"to":{"type":["string","null"]},"measures":{"type":"object","properties":{"surplus_share":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array","items":{"type":"number"}},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"repayment_share":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array","items":{"type":"number"}},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"earnings_headroom":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array","items":{"type":"number"}},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"income_credits":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array","items":{"type":"number"}},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"income_spread":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array","items":{"type":"number"}},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"inferred_share":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array","items":{"type":"number"}},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"dishonours":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array","items":{"type":"number"}},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"overdrawn_days":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"commitment_share":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array","items":{"type":"number"}},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"credit_signals":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array","items":{"type":"number"}},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"prior_late":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"prior_dishonours":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"prior_dpd":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"income_difference":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"categorised_share":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array","items":{"type":"number"}},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]}},"required":["surplus_share","repayment_share","earnings_headroom","income_credits","income_spread","inferred_share","dishonours","overdrawn_days","commitment_share","credit_signals","prior_late","prior_dishonours","prior_dpd","income_difference","categorised_share"]}},"required":["source","n","lenderWeight","from","to","measures"]}},"required":["kind","version","scoreVersion","lender","name","rating","start","k","repaidAt1500","games","completed","writtenOff","writtenOffWithHardshipRelief","counted","lastSeq","since","updatedOn","window","profile"]},"describe":{"type":"object","properties":{"name":{"type":"string"},"rating":{"type":"number"},"start":{"type":"number"},"games":{"type":"number"},"completed":{"type":"number"},"writtenOff":{"type":"number"},"writtenOffWithHardshipRelief":{"type":"number"},"repays":{"type":"number"},"riskClass":{"type":"string"},"pd":{"type":"number"},"says":{"type":"string"},"profile":{"type":"object","properties":{"source":{"type":"string"},"n":{"type":"number"},"lenderWeight":{"type":"number"},"about":{"type":"string"},"measures":{"type":"object","properties":{"surplus_share":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"repayment_share":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"earnings_headroom":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"income_credits":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"income_spread":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"inferred_share":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"dishonours":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"overdrawn_days":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"commitment_share":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"credit_signals":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"prior_late":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"prior_dishonours":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"prior_dpd":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"income_difference":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"categorised_share":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]}},"required":["surplus_share","repayment_share","earnings_headroom","income_credits","income_spread","inferred_share","dishonours","overdrawn_days","commitment_share","credit_signals","prior_late","prior_dishonours","prior_dpd","income_difference","categorised_share"]},"from":{"type":"string"},"to":{"type":"string"}},"required":["source","n","lenderWeight","about","measures"]},"window":{"type":"object","properties":{"months":{"type":"number"},"most":{"type":"number"},"loans":{"type":"number"},"from":{"type":["string","null"]},"to":{"type":["string","null"]}},"required":["months","most","loans","from","to"]}},"required":["name","rating","start","games","completed","writtenOff","writtenOffWithHardshipRelief","repays","riskClass","pd","says","profile","window"]},"entries":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string"},"loan":{"type":"string"},"application":{},"outcome":{"type":"string"},"on":{"type":"string"},"result":{"type":"number"},"rated":{"type":"object","properties":{"scale":{"type":"string"},"rating":{"type":"number"},"anchor":{},"difference":{"type":["number","null"]},"riskClass":{"type":"string"}},"required":["scale","rating","anchor","difference","riskClass"]},"expected":{"type":"number"},"k":{"type":"number"},"before":{"type":"number"},"after":{"type":"number"},"change":{"type":"number"},"why":{},"profile":{"type":"object","properties":{"added":{"type":"boolean"},"why":{"type":"string"},"measures":{"type":["object","null"],"properties":{"surplus_share":{"type":"number"},"repayment_share":{"type":"number"},"earnings_headroom":{"type":"number"},"income_credits":{"type":"number"},"income_spread":{"type":"number"},"inferred_share":{"type":"number"},"dishonours":{"type":"number"},"commitment_share":{"type":"number"},"credit_signals":{"type":"number"},"categorised_share":{"type":"number"}},"required":["surplus_share","repayment_share","earnings_headroom","income_credits","income_spread","inferred_share","dishonours","commitment_share","credit_signals","categorised_share"]},"before":{"type":"object","properties":{"n":{"type":"number"},"source":{"type":"string"},"lenderWeight":{"type":"number"}},"required":["n","source","lenderWeight"]},"after":{"type":"object","properties":{"n":{"type":"number"},"source":{"type":"string"},"lenderWeight":{"type":"number"}},"required":["n","source","lenderWeight"]},"moved":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"format":{"type":"string"},"from":{"type":"number"},"to":{"type":"number"},"says":{"type":"string"}},"required":["key","label","format","from","to","says"]}}},"required":["added","why","measures","before","after","moved"]}},"required":["reason","loan","application","outcome","on","result","rated","expected","k","before","after","change","why","profile"]}},"already":{"type":"array","items":{"type":"string"}},"problems":{"type":"array"},"stores":{"type":"string"}},"required":["model","describe","entries","already","problems","stores"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/score/history":{"post":{"operationId":"postScoreHistory","tags":["Score"],"summary":"Bring a loan’s rating history up to a day from its ledger","description":"Bring a loan’s rating history up to a day from its ledger: every repayment, dishonour, cleared arrears, early payout, completion or write-off (with hardship relief or not) since, each once, with the risk class before and after. Hardship never lowers it.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/score#post-v1-score-history"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{ history: [the entries so far, first to last], terms, events (the ledger’s events), through: YYYY-MM-DD, graceDays?, model? }","content":{"application/json":{"schema":{"type":"object","description":"{ history: [the entries so far, first to last], terms, events (the ledger’s events), through: YYYY-MM-DD, graceDays?, model? }"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"entries":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"reason":{"type":"string"},"on":{"type":"string"},"recordedOn":{"type":"string"},"scale":{"type":"string"},"before":{"type":"number"},"after":{"type":"number"},"change":{"type":"number"},"classBefore":{"type":"string"},"classAfter":{"type":"string"},"result":{"type":"number"},"expected":{"type":"number"},"k":{"type":"number"},"matches":{"type":"number"},"detail":{"type":"object","properties":{"repayment":{"type":"number"},"due":{"type":"string"},"amount":{"type":"number"},"carried":{"type":"number"},"unpaid":{"type":"number"}},"required":["repayment","due","amount","carried"]},"says":{"type":"string"},"gap":{"type":"object","properties":{"model":{"type":"number"},"name":{"type":"string"},"difference":{"type":"number"},"says":{"type":"string"}},"required":["model","name","difference","says"]}},"required":["key","reason","on","recordedOn","scale","before","after","change","classBefore","classAfter","result","expected","k","matches","detail","says","gap"]}},"rating":{"type":"number"},"riskClass":{"type":"string"},"scale":{"type":"string"},"forModelBorrower":{},"stores":{"type":"string"}},"required":["entries","rating","riskClass","scale","forModelBorrower","stores"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/score/benchmark":{"post":{"operationId":"postScoreBenchmark","tags":["Score"],"summary":"Build a model borrower’s profile from closed loans in one go","description":"Build a model borrower’s profile from closed loans in one go.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/score#post-v1-score-benchmark"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{ loans: [{ measures, outcome: good|bad|neither, closedOn }], from?, to? }","content":{"application/json":{"schema":{"type":"object","description":"{ loans: [{ measures, outcome: good|bad|neither, closedOn }], from?, to? }"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"built":{"type":"boolean"},"why":{"type":"string"},"benchmark":{"type":"object","properties":{"source":{"type":"string"},"n":{"type":"number"},"about":{"type":"string"},"measures":{"type":"object","properties":{"surplus_share":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]},"repayment_share":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]},"earnings_headroom":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]},"income_credits":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]},"income_spread":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]},"inferred_share":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]},"dishonours":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]},"overdrawn_days":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]},"commitment_share":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]},"credit_signals":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]},"prior_late":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]},"prior_dishonours":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]},"prior_dpd":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]},"income_difference":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]},"categorised_share":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["surplus_share","repayment_share","earnings_headroom","income_credits","income_spread","inferred_share","dishonours","overdrawn_days","commitment_share","credit_signals","prior_late","prior_dishonours","prior_dpd","income_difference","categorised_share"]}},"required":["source","n","about","measures"]}},"required":["built","why","benchmark"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/score/validate":{"post":{"operationId":"postScoreValidate","tags":["Score"],"summary":"How well the score separates good and bad loans","description":"How well the score separates good and bad loans: AUC, Gini, KS and the bad rate in each risk class beside the range it stands for.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/score#post-v1-score-validate"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{ loans: [{ rating, outcome }] }","content":{"application/json":{"schema":{"type":"object","description":"{ loans: [{ rating, outcome }] }"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"good":{"type":"number"},"bad":{"type":"number"},"auc":{"type":["number","null"]},"gini":{"type":["number","null"]},"ks":{"type":["number","null"]},"byClass":{"type":"array","items":{"type":"object","properties":{"riskClass":{"type":"string"},"pd":{"type":"object","properties":{"from":{"type":"number"},"to":{"type":"number"}},"required":["from","to"]},"loans":{"type":"number"},"badRate":{"type":["number","null"]}},"required":["riskClass","pd","loans","badRate"]}},"validated":{"type":"boolean"},"says":{"type":"string"}},"required":["good","bad","auc","gini","ks","byClass","validated","says"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/score/update":{"post":{"operationId":"postScoreUpdate","tags":["Score"],"summary":"Move a rating by repayment results","description":"Move a rating by repayment results: each instalment is a match.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/score#post-v1-score-update"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{ rating, results: [{ result: on time|late|missed|plan kept }], baseRate? }","content":{"application/json":{"schema":{"type":"object","description":"{ rating, results: [{ result: on time|late|missed|plan kept }], baseRate? }"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"rating":{"type":"number"},"riskClass":{"type":"string"},"matches":{"type":"number"},"steps":{"type":"array","items":{"type":"object","properties":{"result":{"type":"string"},"expected":{"type":"number"},"from":{"type":"number"},"to":{"type":"number"}},"required":["result","expected","from","to"]}}},"required":["rating","riskClass","matches","steps"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/l":{"get":{"operationId":"getL","tags":["LoanManager"],"summary":"Calls a lender’s own program makes against the records its hosted pages keep, under /v1/l/<lender…","description":"Calls a lender’s own program makes against the records its hosted pages keep, under /v1/l/<lender id>/: applications from its own front end, sign-in links for its staff, the payments and requests its borrowers made, the daily run and the funder pack.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#get-v1-l"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"what":{"type":"string"},"key":{"type":"string"},"stores":{"type":"string"},"endpoints":{"type":"object","additionalProperties":{"type":"object","properties":{"what":{"type":"string"},"query":{"type":"object","properties":{"asAt":{"type":"string"},"status":{"type":"string"},"band":{"type":"string"},"hardship":{"type":"string"},"product":{"type":"string"},"q":{"type":"string"},"sort":{"type":"string"},"page":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"}}},"body":{"type":["object","string"],"properties":{"requestSeq":{"type":"string"},"outcome":{"type":"string"},"reference":{"type":"string"},"on":{"type":"string"},"reason":{"type":"string"},"asAt":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"email":{"type":"string"}}},"finances":{"type":"string"},"not_a_decision":{"type":"string"}},"required":["what"]}}},"required":["service","version","what","key","stores","endpoints"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/l/{tenant}/score/model-borrower":{"get":{"operationId":"getLTenantScoreModelBorrower","tags":["Score"],"summary":"The lender’s model borrower","description":"The lender’s model borrower: its name, rating, profile and window, and every loan that moved it, from the lender’s own records.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/score#get-v1-l-tenant-score-model-borrower"},"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"lender":{"type":"string"},"mode":{"type":"string"},"scale":{"type":"string"},"model":{"type":"object","properties":{"kind":{"type":"string"},"version":{"type":"string"},"scoreVersion":{"type":"string"},"lender":{"type":"string"},"name":{"type":"string"},"rating":{"type":"number"},"start":{"type":"number"},"k":{"type":"number"},"repaidAt1500":{"type":"number"},"games":{"type":"number"},"completed":{"type":"number"},"writtenOff":{"type":"number"},"writtenOffWithHardshipRelief":{"type":"number"},"counted":{"type":"number"},"lastSeq":{"type":"number"},"since":{},"updatedOn":{},"profile":{"type":"object","properties":{"source":{"type":"string"},"n":{"type":"number"},"lenderWeight":{"type":"number"},"from":{},"to":{},"measures":{"type":"object","properties":{"surplus_share":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"repayment_share":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"earnings_headroom":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"income_credits":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"income_spread":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"inferred_share":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"dishonours":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"overdrawn_days":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"commitment_share":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"credit_signals":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"prior_late":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"prior_dishonours":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"prior_dpd":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"income_difference":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]},"categorised_share":{"type":"object","properties":{"n":{"type":"number"},"w":{"type":"number"},"values":{"type":"array"},"middle":{"type":"number"},"prior":{"type":"object","properties":{"median":{"type":"number"},"scale":{"type":"number"}},"required":["median","scale"]}},"required":["n","w","values","middle","prior"]}},"required":["surplus_share","repayment_share","earnings_headroom","income_credits","income_spread","inferred_share","dishonours","overdrawn_days","commitment_share","credit_signals","prior_late","prior_dishonours","prior_dpd","income_difference","categorised_share"]}},"required":["source","n","lenderWeight","from","to","measures"]},"window":{"type":"object","properties":{"months":{"type":"number"},"most":{"type":"number"},"loans":{"type":"number"}},"required":["months","most","loans"]}},"required":["kind","version","scoreVersion","lender","name","rating","start","k","repaidAt1500","games","completed","writtenOff","writtenOffWithHardshipRelief","counted","lastSeq","since","updatedOn","profile","window"]},"describe":{"type":"object","properties":{"name":{"type":"string"},"rating":{"type":"number"},"start":{"type":"number"},"games":{"type":"number"},"completed":{"type":"number"},"writtenOff":{"type":"number"},"writtenOffWithHardshipRelief":{"type":"number"},"repays":{"type":"number"},"riskClass":{"type":"string"},"pd":{"type":"number"},"says":{"type":"string"},"profile":{"type":"object","properties":{"source":{"type":"string"},"n":{"type":"number"},"lenderWeight":{"type":"number"},"about":{"type":"string"},"measures":{"type":"object","properties":{"surplus_share":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"repayment_share":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"earnings_headroom":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"income_credits":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"income_spread":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"inferred_share":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"dishonours":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"overdrawn_days":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"commitment_share":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"credit_signals":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"prior_late":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"prior_dishonours":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"prior_dpd":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"income_difference":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]},"categorised_share":{"type":"object","properties":{"label":{"type":"string"},"format":{"type":"string"},"better":{"type":"string"},"n":{"type":"number"},"w":{"type":"number"},"middle":{"type":"number"},"prior":{"type":"number"}},"required":["label","format","better","n","w","middle","prior"]}},"required":["surplus_share","repayment_share","earnings_headroom","income_credits","income_spread","inferred_share","dishonours","overdrawn_days","commitment_share","credit_signals","prior_late","prior_dishonours","prior_dpd","income_difference","categorised_share"]}},"required":["source","n","lenderWeight","about","measures"]},"window":{"type":"object","properties":{"months":{"type":"number"},"most":{"type":"number"},"loans":{"type":"number"},"from":{},"to":{}},"required":["months","most","loans","from","to"]}},"required":["name","rating","start","games","completed","writtenOff","writtenOffWithHardshipRelief","repays","riskClass","pd","says","profile","window"]},"history":{"type":"array"}},"required":["lender","mode","scale","model","describe","history"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/l/{tenant}/score/history/{loanRef}":{"get":{"operationId":"getLTenantScoreHistoryLoanRef","tags":["Score"],"summary":"A loan’s rating history","description":"A loan’s rating history: the assessment against the model borrower, measure by measure, then every change since, each with its day, reason, risk class before and after, and the gap to the model borrower; its risk class now, D once written off or 90 days past due.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/score#get-v1-l-tenant-score-history-loanref"},"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"loanRef","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"loan":{"type":"string"},"mode":{"type":"string"},"scale":{"type":"string"},"rating":{"type":"number"},"riskClass":{"type":"string"},"riskClassAtApplication":{"type":"string"},"modelBorrower":{"type":"string"},"entries":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"reason":{"type":"string"},"application":{},"loan":{"type":"string"},"on":{"type":"string"},"scale":{"type":"string"},"version":{"type":"string"},"scored":{"type":"boolean"},"why":{},"before":{},"after":{"type":"number"},"change":{},"rating":{"type":"number"},"riskClass":{"type":"string"},"riskClassNotch":{"type":"string"},"pd":{"type":"number"},"calibrated":{"type":"boolean"},"says":{"type":"string"},"model":{"type":"object","properties":{"name":{"type":"string"},"rating":{"type":"number"},"source":{"type":"string"}},"required":["name","rating","source"]},"against":{},"difference":{},"expected":{},"repays":{"type":"number"},"coverage":{},"comparison":{"type":"array"},"components":{"type":"array"},"measures":{"type":"object","properties":{}},"dishonoursAndDefaults":{}},"required":["key","reason","application","loan","on","scale","version","scored","why","before","after","change","rating","riskClass","riskClassNotch","pd","calibrated","says","model","against","difference","expected","repays","coverage","comparison","components","measures","dishonoursAndDefaults"]}}},"required":["loan","mode","scale","rating","riskClass","riskClassAtApplication","modelBorrower","entries"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/sign":{"get":{"operationId":"getSign","tags":["Sign"],"summary":"Signing for any document","description":"Signing for any document.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/sign#get-v1-sign"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"method":{"type":"string"},"stores":{"type":"string"},"what":{"type":"string"},"price":{"type":"string"},"endpoints":{"type":"object","additionalProperties":{"type":"object","properties":{"what":{"type":"string"},"body":{"type":"object","properties":{"document":{"type":"string"},"title":{"type":"string"},"signer":{"type":"string"},"consent":{"type":"string"},"expiresInDays":{"type":"string"},"returnUrl":{"type":"string"},"requireDrawn":{"type":"string"},"token":{"type":"string"},"evidence":{"type":"string"},"seal":{"type":"string"}}}},"required":["what","body"]}},"pages":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","method","stores","what","price","endpoints","pages"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/sign/requests":{"post":{"operationId":"postSignRequests","tags":["Sign"],"summary":"Ask for a signature","description":"Ask for a signature. Answers with the link to send the signer: the request travels sealed inside it, so nothing is stored.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/sign#post-v1-sign-requests"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"document":{"description":"{ \"html\": \"…\" } — travels in the link; or { \"sha256\": \"…\", \"url\": \"https://…\" } for a document you host, such as a PDF"},"title":{"description":"what the signer sees it called"},"signer":{"description":"{ \"name\": \"the full name they must type\", \"email\" | \"mobile\": \"one you hold, for them to confirm\" } — hashed on arrival"},"consent":{"description":"{ \"text\", \"version\" } — the words they agree to; neutral words if left out"},"expiresInDays":{"description":"1 to 30; 7 if left out"},"returnUrl":{"description":"https:// — where the signer goes afterwards, with ?sign=<evidence token>"},"requireDrawn":{"description":"true — the signer must draw their signature as well as type their name; if left out, your configuration’s signing.requireDrawn, or drawing is the signer’s choice"}}}}}},"responses":{"201":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"expiresAt":{"type":"string"},"documentHash":{"type":"string"},"lender":{"type":"string"},"mode":{"type":"string"}},"required":["id","url","expiresAt","documentHash","lender","mode"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/sign/evidence":{"post":{"operationId":"postSignEvidence","tags":["Sign"],"summary":"Open the evidence token a signer brought back to your return address","description":"Open the evidence token a signer brought back to your return address: the evidence, its seal, the check, and a certificate of signing to keep. Only the lender that asked can open it.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/sign#post-v1-sign-evidence"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"description":"the sign= value"}}}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"evidence":{"type":"object","properties":{"version":{"type":"string"},"method":{"type":"string"},"requestId":{"type":"string"},"lender":{"type":"string"},"mode":{"type":"string"},"title":{"type":"string"},"documentHash":{"type":"string"},"documentUrl":{},"name":{"type":"string"},"mark":{"type":"string"},"consentText":{"type":"string"},"consentVersion":{"type":"string"},"contact":{"type":["object","null"],"properties":{"confirmed":{"type":"string"}},"required":["confirmed"]},"signedAt":{"type":"string"},"expiresAt":{"type":"string"},"ipHash":{"type":["string","null"]},"uaHash":{"type":["string","null"]},"drawn":{"type":"object","properties":{"format":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"strokes":{"type":"string"},"sha256":{"type":"string"}},"required":["format","width","height","strokes","sha256"]}},"required":["version","method","requestId","lender","mode","title","documentHash","documentUrl","name","mark","consentText","consentVersion","contact","signedAt","expiresAt","ipHash","uaHash"]},"seal":{"type":"object","properties":{"alg":{"type":"string"},"kid":{"type":"string"},"value":{"type":"string"}},"required":["alg","kid","value"]},"verification":{"type":"object","properties":{"valid":{"type":"boolean"},"problems":{"type":"array"},"sealedWith":{"type":"string"},"sandbox":{"type":"boolean"},"lender":{"type":"string"},"mode":{"type":"string"},"requestId":{"type":"string"},"documentHash":{"type":"string"},"signedAt":{"type":"string"},"drawn":{"type":"boolean"},"drawingHash":{"type":["string","null"]},"notSealed":{"type":"array"},"says":{"type":"string"}},"required":["valid","problems","sealedWith","sandbox","lender","mode","requestId","documentHash","signedAt","drawn","drawingHash","notSealed","says"]},"certificate":{"type":"string"}},"required":["evidence","seal","verification","certificate"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/sign/certificate":{"post":{"operationId":"postSignCertificate","tags":["Sign"],"summary":"The certificate of signing as a PDF, to keep with the document","description":"The certificate of signing as a PDF, to keep with the document: the drawn signature as drawn, the typed name, the fingerprints and the seal. Made only for evidence whose seal checks; answers application/pdf.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/sign#post-v1-sign-certificate"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"evidence":{"description":"as returned"},"seal":{"description":"as returned"}}}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/sign/verify":{"post":{"operationId":"postSignVerify","tags":["Sign"],"summary":"Check evidence and its seal, and the document if you send it","description":"Check evidence and its seal, and the document if you send it: valid, or exactly why not, each reason with a code.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/sign#post-v1-sign-verify"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"evidence":{"description":"as returned"},"seal":{"description":"as returned"},"document":{"description":"{ \"html\" } or { \"sha256\" } — optional"}}}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"valid":{"type":"boolean"},"problems":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"says":{"type":"string"}},"required":["code","says"]}},"sealedWith":{"type":["string","null"]},"sandbox":{"type":"boolean"},"lender":{"type":["string","null"]},"mode":{"type":["string","null"]},"requestId":{"type":["string","null"]},"documentHash":{"type":["string","null"]},"signedAt":{"type":["string","null"]},"drawn":{"type":"boolean"},"drawingHash":{},"notSealed":{"type":"array"},"says":{"type":"string"},"askedByYou":{"type":["boolean","null"]}},"required":["valid","problems","sealedWith","sandbox","lender","mode","requestId","documentHash","signedAt","drawn","drawingHash","notSealed","says","askedByYou"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/keys":{"get":{"operationId":"getKeys","tags":["Authentication"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/authentication#get-v1-keys"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"stores":{"type":"string"},"how":{"type":"string"},"kinds":{"type":"object","properties":{"cc_live_":{"type":"string"},"cc_test_":{"type":"string"}},"required":["cc_live_","cc_test_"]},"endpoints":{"type":"object","additionalProperties":{"type":"object","properties":{"what":{"type":"string"},"query":{"type":"object","properties":{"month":{"type":"string"},"format":{"type":"string"},"lender":{"type":"string"},"issued":{"type":"string"},"remake":{"type":"string"},"adjustment":{"type":"string"}},"required":["month"]},"body":{"type":"string"}},"required":["what"]}},"docs":{"type":"string"}},"required":["service","version","stores","how","kinds","endpoints","docs"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/keys/sandbox":{"post":{"operationId":"postKeysSandbox","tags":["Authentication"],"summary":"A sandbox key, straight away, for 30 days","description":"A sandbox key, straight away, for 30 days. No account.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/authentication#post-v1-keys-sandbox"},"responses":{"201":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"},"mode":{"type":"string"},"expires":{"type":"string"},"use":{"type":"string"},"note":{"type":"string"}},"required":["key","id","mode","expires","use","note"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/keys/me":{"get":{"operationId":"getKeysMe","tags":["Authentication"],"summary":"What the key you sent is","description":"What the key you sent is: its id, lender, mode, scopes and expiry. Never the key itself.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/authentication#get-v1-keys-me"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string"},"lender":{"type":"string"},"name":{"type":["string","null"]},"mode":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"issued":{"type":"string"},"expires":{"type":["string","null"]}},"required":["id","lender","name","mode","scopes","issued","expires"]}},"required":["key"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/usage":{"get":{"operationId":"getUsage","tags":["Authentication"],"summary":"Your month","description":"Your month: every call and check counted, each application decided on your hosted pages and each advance, and what they come to at the published prices on your own terms, Launch included. Test and sandbox use, and refused calls, are never charged. The price is what you pay: GST is never added on top. total is what is payable, and gstIncluded the GST inside it once Creditcrest is registered for GST. spend is the month so far, its estimate for the month, and your spend alert with how far through it the month is.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/authentication#get-v1-usage"},"parameters":[{"name":"month","in":"query","required":false,"description":"YYYY-MM, a calendar month in Sydney; this month when left out","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"lender":{"type":"string"},"month":{"type":"string"},"timeZone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"currency":{"type":"string"},"counts":{"type":"array","items":{"type":"object","properties":{"item":{"type":"string"},"mode":{"type":"string"},"status":{"type":["number","null"]},"count":{"type":"number"}},"required":["item","mode","status","count"]}},"services":{"type":"string"},"orderForm":{"type":"boolean"},"decisions":{"type":"number"},"junk":{"type":"object","properties":{"applications":{"type":"number"},"closed":{"type":"number"},"cap":{"type":"number"},"free":{"type":"number"},"charged":{"type":"number"},"flagged":{"type":"number"},"duplicate":{"type":"number"},"automated":{"type":"number"},"over":{"type":"array"},"note":{}},"required":["applications","closed","cap","free","charged","flagged","duplicate","automated","over","note"]},"advances":{"type":"array","items":{"type":"object","properties":{"loan":{"type":"string"},"at":{"type":"string"},"on":{"type":"string"},"cents":{"type":"number"},"amount":{"type":"number"},"fee":{"type":"number"},"workings":{"type":"array","items":{"type":"object","properties":{"from":{"type":"number"},"to":{"type":"number"},"rate":{"type":"number"},"amount":{"type":"number"}},"required":["from","to","rate","amount"]}},"version":{"type":"number"},"returned":{"type":"boolean"}},"required":["loan","at","on","cents","amount","fee","workings","version","returned"]}},"credits":{"type":"array"},"nothingToCredit":{"type":"array"},"lines":{"type":"array","items":{"type":"object","properties":{"item":{"type":"string"},"meter":{"type":"string"},"product":{"type":["string","null"]},"description":{"type":"string"},"quantity":{"type":["number","null"]},"unit":{"type":["number","null"]},"amount":{"type":"number"},"version":{"type":"number"},"note":{"type":"string"},"share":{"type":"number"}},"required":["item","meter","product","description","quantity","unit","amount"]}},"list":{"type":"number"},"credited":{"type":"number"},"volume":{"type":"object","properties":{"serviceFees":{"type":"number"},"discount":{"type":"number"},"version":{},"workings":{"type":"array"}},"required":["serviceFees","discount","version","workings"]},"launch":{"type":["object","null"],"properties":{"month":{"type":"number"},"signedOn":{"type":"string"},"firstMonth":{"type":"string"},"discount":{"type":"number"},"deferred":{"type":"number"},"repaid":{"type":"number"},"part":{},"of":{"type":"number"},"deferredInMonth1":{},"lockedUntil":{"type":"string"},"says":{"type":"string"},"terms":{"type":"object","properties":{"discount":{"type":"number"},"discountMonths":{"type":"number"},"deferredMonths":{"type":"number"},"repaidOverMonths":{"type":"number"},"priceLockMonths":{"type":"number"}},"required":["discount","discountMonths","deferredMonths","repaidOverMonths","priceLockMonths"]}},"required":["month","signedOn","firstMonth","discount","deferred","repaid","part","of","deferredInMonth1","lockedUntil","says","terms"]},"total":{"type":"number"},"gstRegistered":{"type":"boolean"},"gstIncluded":{"type":"number"},"summary":{"type":"object","properties":{"perDecision":{"type":"number"},"onAdvances":{"type":"number"},"checks":{"type":"number"},"discounts":{"type":"number"},"launch":{"type":"number"},"total":{"type":"number"},"funded":{"type":"number"},"perFundedLoan":{"type":["number","null"]}},"required":["perDecision","onAdvances","checks","discounts","launch","total","funded","perFundedLoan"]},"prices":{"type":"object","properties":{"signed":{"type":"number"},"version":{"type":"number"},"since":{"type":["string","null"]},"lower":{"type":"array"},"lockedUntil":{"type":["string","null"]},"pending":{"type":"array","items":{"type":"object","properties":{"version":{"type":"number"},"published":{"type":"string"},"effective":{"type":"string"},"raises":{"type":"boolean"},"appliesFrom":{"type":["string","null"]}},"required":["version","published","effective","raises","appliesFrom"]}},"bands":{"type":"array","items":{"type":"object","properties":{"upTo":{"type":["number","null"]},"rate":{"type":"number"}},"required":["upTo","rate"]}}},"required":["signed","version","since","lower","lockedUntil","pending","bands"]},"takeRateShare":{"type":"number"},"notBilled":{"type":"array","items":{"type":"object","properties":{"item":{"type":"string"},"mode":{"type":"string"},"status":{"type":"number"},"count":{"type":"number"},"why":{"type":"string"}},"required":["item","mode","status","count","why"]}},"covers":{"type":"string"},"notCovered":{"type":"string"},"spend":{"type":"object","properties":{"monthToDate":{"type":"number"},"estimate":{"type":["number","null"]},"alert":{"type":["number","null"]},"reached":{"type":["number","null"]},"problems":{"type":"array"}},"required":["monthToDate","estimate","alert","reached","problems"]},"keys":{"type":"string"},"issued":{"type":"object","properties":{"number":{"type":"string"},"adjustments":{"type":"array"},"total":{"type":"number"},"says":{"type":"string"}},"required":["number","adjustments","total","says"]}},"required":["lender","month","timeZone","from","to","currency","counts","services","orderForm","decisions","junk","advances","credits","nothingToCredit","lines","list","credited","volume","launch","total","gstRegistered","gstIncluded","summary","prices","takeRateShare","notBilled","covers","notCovered","spend","keys"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/admin/usage":{"get":{"operationId":"getAdminUsage","tags":["Authentication"],"summary":"Creditcrest’s own","description":"Creditcrest’s own: every lender’s month, priced, for invoicing. Needs Creditcrest’s admin token, not a key.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/authentication#get-v1-admin-usage"},"parameters":[{"name":"month","in":"query","required":false,"description":"YYYY-MM, a calendar month in Sydney","schema":{"type":"string"}},{"name":"format","in":"query","required":false,"description":"csv for a spreadsheet; JSON otherwise","schema":{"type":"string"}},{"name":"lender","in":"query","required":false,"description":"one lender’s id, to run it for one","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer, as application/json or text/csv. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"month":{"type":"string"},"timeZone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"currency":{"type":"string"},"lenders":{"type":"array","items":{"type":"object","properties":{"lender":{"type":"string"},"month":{"type":"string"},"timeZone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"currency":{"type":"string"},"counts":{"type":"array","items":{"type":"object","properties":{"item":{"type":"string"},"mode":{"type":"string"},"status":{"type":["number","null"]},"count":{"type":"number"}},"required":["item","mode","status","count"]}},"services":{"type":"string"},"orderForm":{"type":"boolean"},"decisions":{"type":"number"},"junk":{"type":"object","properties":{"applications":{"type":"number"},"closed":{"type":"number"},"cap":{"type":"number"},"free":{"type":"number"},"charged":{"type":"number"},"flagged":{"type":"number"},"duplicate":{"type":"number"},"automated":{"type":"number"},"over":{"type":"array"},"note":{}},"required":["applications","closed","cap","free","charged","flagged","duplicate","automated","over","note"]},"advances":{"type":"array","items":{"type":"object","properties":{"loan":{"type":"string"},"at":{"type":"string"},"on":{"type":"string"},"cents":{"type":"number"},"amount":{"type":"number"},"fee":{"type":"number"},"workings":{"type":"array","items":{"type":"object","properties":{"from":{"type":"number"},"to":{"type":"number"},"rate":{"type":"number"},"amount":{"type":"number"}},"required":["from","to","rate","amount"]}},"version":{"type":"number"},"returned":{"type":"boolean"}},"required":["loan","at","on","cents","amount","fee","workings","version","returned"]}},"credits":{"type":"array"},"nothingToCredit":{"type":"array"},"lines":{"type":"array","items":{"type":"object","properties":{"item":{"type":"string"},"meter":{"type":"string"},"product":{"type":["string","null"]},"description":{"type":"string"},"quantity":{"type":["number","null"]},"unit":{"type":["number","null"]},"amount":{"type":"number"},"version":{"type":"number"},"share":{"type":"number"},"note":{"type":"string"}},"required":["item","meter","product","description","quantity","unit","amount"]}},"list":{"type":"number"},"credited":{"type":"number"},"volume":{"type":"object","properties":{"serviceFees":{"type":"number"},"discount":{"type":"number"},"version":{},"workings":{"type":"array"}},"required":["serviceFees","discount","version","workings"]},"launch":{"type":["object","null"],"properties":{"month":{"type":"number"},"signedOn":{"type":"string"},"firstMonth":{"type":"string"},"discount":{"type":"number"},"deferred":{"type":"number"},"repaid":{"type":"number"},"part":{},"of":{"type":"number"},"deferredInMonth1":{},"lockedUntil":{"type":"string"},"says":{"type":"string"},"terms":{"type":"object","properties":{"discount":{"type":"number"},"discountMonths":{"type":"number"},"deferredMonths":{"type":"number"},"repaidOverMonths":{"type":"number"},"priceLockMonths":{"type":"number"}},"required":["discount","discountMonths","deferredMonths","repaidOverMonths","priceLockMonths"]}},"required":["month","signedOn","firstMonth","discount","deferred","repaid","part","of","deferredInMonth1","lockedUntil","says","terms"]},"total":{"type":"number"},"gstRegistered":{"type":"boolean"},"gstIncluded":{"type":"number"},"summary":{"type":"object","properties":{"perDecision":{"type":"number"},"onAdvances":{"type":"number"},"checks":{"type":"number"},"discounts":{"type":"number"},"launch":{"type":"number"},"total":{"type":"number"},"funded":{"type":"number"},"perFundedLoan":{}},"required":["perDecision","onAdvances","checks","discounts","launch","total","funded","perFundedLoan"]},"prices":{"type":"object","properties":{"signed":{"type":"number"},"version":{"type":"number"},"since":{},"lower":{"type":"array"},"lockedUntil":{"type":["string","null"]},"pending":{"type":"array","items":{"type":"object","properties":{"version":{"type":"number"},"published":{"type":"string"},"effective":{"type":"string"},"raises":{"type":"boolean"},"appliesFrom":{"type":["string","null"]}},"required":["version","published","effective","raises","appliesFrom"]}},"bands":{"type":"array","items":{"type":"object","properties":{"upTo":{"type":["number","null"]},"rate":{"type":"number"}},"required":["upTo","rate"]}}},"required":["signed","version","since","lower","lockedUntil","pending","bands"]},"takeRateShare":{"type":"number"},"notBilled":{"type":"array","items":{"type":"object","properties":{"item":{"type":"string"},"mode":{"type":"string"},"status":{"type":"number"},"count":{"type":"number"},"why":{"type":"string"}},"required":["item","mode","status","count","why"]}},"problems":{"type":"array"},"covers":{"type":"string"},"notCovered":{"type":"string"},"issued":{"type":"object","properties":{"number":{"type":"string"},"sha256":{"type":"string"},"issuedAt":{"type":"string"},"adjustments":{"type":"array","items":{"type":"string"}},"remadeAgrees":{"type":"boolean"},"remadeTotal":{"type":"number"},"says":{"type":"string"}},"required":["number","sha256","issuedAt","adjustments","remadeAgrees","remadeTotal","says"]}},"required":["lender","month","timeZone","currency","counts","decisions","advances","credits","lines","list","launch","total","gstRegistered","gstIncluded","prices","notBilled","problems"]}},"totals":{"type":"object","properties":{"lenders":{"type":"number"},"total":{"type":"number"},"gstIncluded":{"type":"number"}},"required":["lenders","total","gstIncluded"]},"covers":{"type":"string"},"notCovered":{"type":"string"}},"required":["month","timeZone","from","to","currency","lenders","totals","covers","notCovered"]}},"text/csv":{"schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"admin":[]}]},"post":{"operationId":"postAdminUsage","tags":["Authentication"],"summary":"Creditcrest’s own","description":"Creditcrest’s own: puts back counts that could not be written at the time, each once. Needs Creditcrest’s admin token.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/authentication#post-v1-admin-usage"},"requestBody":{"required":true,"description":"{rows: [{id, lender, mode, item, kid, status, of, amount, at}]}","content":{"application/json":{"schema":{"type":"object","description":"{rows: [{id, lender, mode, item, kid, status, of, amount, at}]}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"kept":{"type":"number"},"already":{"type":"number"},"refused":{"type":"array","items":{"type":"object","properties":{"index":{"type":"number"},"why":{"type":"string"}},"required":["index","why"]}},"invoiced":{"type":"array","items":{"type":"object","properties":{"lender":{"type":"string"},"month":{"type":"string"},"number":{"type":"string"},"then":{"type":"string"}},"required":["lender","month","number","then"]}}},"required":["kept","already","refused","invoiced"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"admin":[]}]}},"/v1/admin/invoices/{lender}":{"get":{"operationId":"getAdminInvoicesLender","tags":["Authentication"],"summary":"Creditcrest’s own","description":"Creditcrest’s own: one lender’s invoice for a month — its number, dates, lines, price list version, Launch and total, and on a tax invoice the GST the total includes (none is added) — as JSON or a PDF. The first time it is final it is kept, with its SHA-256, and that invoice is answered ever after, byte for byte. Needs Creditcrest’s admin token, not a key.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/authentication#get-v1-admin-invoices-lender"},"parameters":[{"name":"lender","in":"path","required":true,"schema":{"type":"string"}},{"name":"month","in":"query","required":false,"description":"YYYY-MM, a calendar month in Sydney","schema":{"type":"string"}},{"name":"format","in":"query","required":false,"description":"pdf for the document; JSON otherwise","schema":{"type":"string"}},{"name":"issued","in":"query","required":false,"description":"YYYY-MM-DD, when it is issued later than the first day after the month","schema":{"type":"string"}},{"name":"remake","in":"query","required":false,"description":"1 to make an issued month again and say whether it still agrees (409 when it differs)","schema":{"type":"string"}},{"name":"adjustment","in":"query","required":false,"description":"n for the month’s nth adjustment note","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer, as application/json or application/pdf. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string"},"title":{"type":"string"},"status":{"type":"string"},"month":{"type":"string"},"period":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]},"issuedOn":{"type":"string"},"dueOn":{"type":["string","null"]},"paymentDays":{"type":"number"},"seller":{"type":"object","properties":{"name":{"type":"string"},"abn":{"type":"string"}},"required":["name","abn"]},"buyer":{"type":"object","properties":{"lender":{"type":"string"},"legalName":{"type":"string"},"abn":{"type":"string"}},"required":["lender","legalName","abn"]},"currency":{"type":"string"},"summary":{"type":"object","properties":{"perDecision":{"type":"number"},"onAdvances":{"type":"number"},"checks":{"type":"number"},"discounts":{"type":"number"},"launch":{"type":"number"},"total":{"type":"number"},"funded":{"type":"number"},"perFundedLoan":{"type":["number","null"]}},"required":["perDecision","onAdvances","checks","discounts","launch","total","funded","perFundedLoan"]},"volume":{"type":"object","properties":{"serviceFees":{"type":"number"},"discount":{"type":"number"},"version":{},"workings":{"type":"array"}},"required":["serviceFees","discount","version","workings"]},"lines":{"type":"array","items":{"type":"object","properties":{"item":{"type":"string"},"meter":{"type":"string"},"product":{"type":["string","null"]},"description":{"type":"string"},"quantity":{"type":["number","null"]},"unit":{"type":["number","null"]},"amount":{"type":"number"},"version":{"type":"number"},"share":{"type":"number"},"note":{"type":"string"},"quantityBefore":{"type":"number"},"quantityAfter":{"type":["number","null"]},"before":{"type":"number"},"after":{"type":"number"}},"required":["item","meter","product","description","amount"]}},"list":{"type":"number"},"total":{"type":"number"},"gstRegistered":{"type":"boolean"},"gstIncluded":{"type":"number"},"gstSays":{"type":"string"},"launch":{"type":["object","null"],"properties":{"month":{"type":"number"},"signedOn":{"type":"string"},"firstMonth":{"type":"string"},"discount":{"type":"number"},"deferred":{"type":"number"},"repaid":{"type":"number"},"part":{"type":["number","null"]},"of":{"type":"number"},"deferredInMonth1":{"type":["number","null"]},"lockedUntil":{"type":"string"},"says":{"type":"string"},"terms":{"type":"object","properties":{"discount":{"type":"number"},"discountMonths":{"type":"number"},"deferredMonths":{"type":"number"},"repaidOverMonths":{"type":"number"},"priceLockMonths":{"type":"number"}},"required":["discount","discountMonths","deferredMonths","repaidOverMonths","priceLockMonths"]}},"required":["month","signedOn","firstMonth","discount","deferred","repaid","part","of","deferredInMonth1","lockedUntil","says","terms"]},"decisions":{"type":"number"},"services":{"type":"string"},"advances":{"type":"array","items":{"type":"object","properties":{"loan":{"type":"string"},"at":{"type":"string"},"on":{"type":"string"},"cents":{"type":"number"},"amount":{"type":"number"},"fee":{"type":"number"},"workings":{"type":"array","items":{"type":"object","properties":{"from":{"type":"number"},"to":{"type":"number"},"rate":{"type":"number"},"amount":{"type":"number"}},"required":["from","to","rate","amount"]}},"version":{"type":"number"},"returned":{"type":"boolean"}},"required":["loan","at","on","cents","amount","fee","workings","version","returned"]}},"credits":{"type":"array","items":{"type":"object","properties":{"loan":{"type":"string"},"at":{"type":"string"},"on":{"type":"string"},"cents":{"type":"number"},"amount":{"type":"number"},"advancedMonth":{"type":"string"},"credit":{"type":"number"}},"required":["loan","at","on","cents","amount","advancedMonth","credit"]}},"takeRateShare":{"type":"number"},"prices":{"type":"object","properties":{"signed":{"type":"number"},"version":{"type":"number"},"since":{"type":["string","null"]},"lower":{"type":"array"},"lockedUntil":{"type":"string"},"pending":{"type":"array","items":{"type":"object","properties":{"version":{"type":"number"},"published":{"type":"string"},"effective":{"type":"string"},"raises":{"type":"boolean"},"appliesFrom":{"type":"string"}},"required":["version","published","effective","raises","appliesFrom"]}},"bands":{"type":"array","items":{"type":"object","properties":{"upTo":{"type":["number","null"]},"rate":{"type":"number"}},"required":["upTo","rate"]}}},"required":["signed","version","since","lower","lockedUntil","pending","bands"]},"payTo":{"type":["array","null"],"items":{"type":"string"}},"payToSays":{"type":["string","null"]},"notes":{"type":"array","items":{"type":"string"}},"problems":{"type":"array","items":{"type":"string"}},"forCreditcrest":{"type":"array","items":{"type":"string"}},"notBilled":{"type":"array"},"usage":{"type":"object","properties":{"counts":{"type":"array","items":{"type":"object","properties":{"item":{"type":"string"},"mode":{"type":"string"},"status":{"type":["number","null"]},"count":{"type":"number"}},"required":["item","mode","status","count"]}},"notBilled":{"type":"array"},"nothingToCredit":{"type":"array","items":{"type":"object","properties":{"loan":{"type":"string"},"on":{"type":"string"},"amount":{"type":"number"}},"required":["loan","on","amount"]}},"covers":{"type":"string"},"notCovered":{"type":"string"}},"required":["counts","notBilled","nothingToCredit","covers","notCovered"]},"kind":{"type":"string"},"adjusts":{"type":"object","properties":{"number":{"type":"string"},"issuedOn":{"type":"string"},"sha256":{"type":"string"}},"required":["number","issuedOn","sha256"]},"replaces":{},"reason":{"type":"string"},"before":{"type":"object","properties":{"total":{"type":"number"},"gstIncluded":{"type":"number"}},"required":["total","gstIncluded"]},"after":{"type":"object","properties":{"total":{"type":"number"},"gstIncluded":{"type":"number"}},"required":["total","gstIncluded"]},"difference":{"type":"object","properties":{"total":{"type":"number"},"gstIncluded":{"type":"number"}},"required":["total","gstIncluded"]},"changed":{"type":"array","items":{"type":"string"}},"standing":{"type":"object","properties":{"number":{"type":"string"},"title":{"type":"string"},"status":{"type":"string"},"month":{"type":"string"},"period":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]},"issuedOn":{"type":"string"},"dueOn":{"type":"string"},"paymentDays":{"type":"number"},"seller":{"type":"object","properties":{"name":{"type":"string"},"abn":{"type":"string"}},"required":["name","abn"]},"buyer":{"type":"object","properties":{"lender":{"type":"string"},"legalName":{"type":"string"},"abn":{"type":"string"}},"required":["lender","legalName","abn"]},"currency":{"type":"string"},"summary":{"type":"object","properties":{"perDecision":{"type":"number"},"onAdvances":{"type":"number"},"checks":{"type":"number"},"discounts":{"type":"number"},"launch":{"type":"number"},"total":{"type":"number"},"funded":{"type":"number"},"perFundedLoan":{"type":"number"}},"required":["perDecision","onAdvances","checks","discounts","launch","total","funded","perFundedLoan"]},"volume":{"type":"object","properties":{"serviceFees":{"type":"number"},"discount":{"type":"number"},"version":{},"workings":{"type":"array"}},"required":["serviceFees","discount","version","workings"]},"lines":{"type":"array","items":{"type":"object","properties":{"item":{"type":"string"},"meter":{"type":"string"},"product":{"type":"string"},"description":{"type":"string"},"quantity":{"type":"number"},"unit":{"type":"number"},"amount":{"type":"number"},"version":{"type":"number"}},"required":["item","meter","product","description","quantity","unit","amount","version"]}},"list":{"type":"number"},"total":{"type":"number"},"gstRegistered":{"type":"boolean"},"gstIncluded":{"type":"number"},"gstSays":{"type":"string"},"launch":{},"decisions":{"type":"number"},"services":{"type":"string"},"advances":{"type":"array","items":{"type":"object","properties":{"loan":{"type":"string"},"at":{"type":"string"},"on":{"type":"string"},"cents":{"type":"number"},"amount":{"type":"number"},"fee":{"type":"number"},"workings":{"type":"array","items":{"type":"object","properties":{"from":{"type":"number"},"to":{"type":"number"},"rate":{"type":"number"},"amount":{"type":"number"}},"required":["from","to","rate","amount"]}},"version":{"type":"number"},"returned":{"type":"boolean"}},"required":["loan","at","on","cents","amount","fee","workings","version","returned"]}},"credits":{"type":"array"},"takeRateShare":{"type":"number"},"prices":{"type":"object","properties":{"signed":{"type":"number"},"version":{"type":"number"},"since":{},"lower":{"type":"array"},"lockedUntil":{"type":"string"},"pending":{"type":"array","items":{"type":"object","properties":{"version":{"type":"number"},"published":{"type":"string"},"effective":{"type":"string"},"raises":{"type":"boolean"},"appliesFrom":{"type":"string"}},"required":["version","published","effective","raises","appliesFrom"]}},"bands":{"type":"array","items":{"type":"object","properties":{"upTo":{"type":["number","null"]},"rate":{"type":"number"}},"required":["upTo","rate"]}}},"required":["signed","version","since","lower","lockedUntil","pending","bands"]},"payTo":{},"payToSays":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}},"problems":{"type":"array"},"forCreditcrest":{"type":"array","items":{"type":"string"}},"notBilled":{"type":"array"},"usage":{"type":"object","properties":{"counts":{"type":"array","items":{"type":"object","properties":{"item":{"type":"string"},"mode":{"type":"string"},"status":{"type":["number","null"]},"count":{"type":"number"}},"required":["item","mode","status","count"]}},"notBilled":{"type":"array"},"nothingToCredit":{"type":"array"},"covers":{"type":"string"},"notCovered":{"type":"string"}},"required":["counts","notBilled","nothingToCredit","covers","notCovered"]}},"required":["number","title","status","month","period","issuedOn","dueOn","paymentDays","seller","buyer","currency","summary","volume","lines","list","total","gstRegistered","gstIncluded","gstSays","launch","decisions","services","advances","credits","takeRateShare","prices","payTo","payToSays","notes","problems","forCreditcrest","notBilled","usage"]}},"required":["number","title","status","month","period","issuedOn","dueOn","paymentDays","seller","buyer","currency","lines","gstRegistered","gstSays","payTo","payToSays","notes","forCreditcrest"]}},"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"admin":[]}]}},"/v1/admin/invoices/{lender}/adjustments":{"post":{"operationId":"postAdminInvoicesLenderAdjustments","tags":["Authentication"],"summary":"Creditcrest’s own","description":"Creditcrest’s own: an adjustment note for an issued month made again — its own document, naming the invoice it adjusts and that invoice’s SHA-256, and changing what is owed by the difference. The issued invoice is never changed. Needs Creditcrest’s admin token.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/authentication#post-v1-admin-invoices-lender-adjustments"},"parameters":[{"name":"lender","in":"path","required":true,"schema":{"type":"string"}},{"name":"month","in":"query","required":false,"description":"YYYY-MM, the issued month","schema":{"type":"string"}},{"name":"format","in":"query","required":false,"description":"pdf for the document; JSON otherwise","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"{reason}: why it is issued, at most 300 characters","content":{"application/json":{"schema":{"type":"object","description":"{reason}: why it is issued, at most 300 characters"}}}},"responses":{"201":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string"},"title":{"type":"string"},"kind":{"type":"string"},"status":{"type":"string"},"month":{"type":"string"},"period":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]},"issuedOn":{"type":"string"},"dueOn":{},"paymentDays":{"type":"number"},"adjusts":{"type":"object","properties":{"number":{"type":"string"},"issuedOn":{"type":"string"},"sha256":{"type":"string"}},"required":["number","issuedOn","sha256"]},"replaces":{},"reason":{"type":"string"},"seller":{"type":"object","properties":{"name":{"type":"string"},"abn":{"type":"string"}},"required":["name","abn"]},"buyer":{"type":"object","properties":{"lender":{"type":"string"},"legalName":{"type":"string"},"abn":{"type":"string"}},"required":["lender","legalName","abn"]},"currency":{"type":"string"},"lines":{"type":"array","items":{"type":"object","properties":{"item":{"type":"string"},"meter":{"type":"string"},"product":{"type":"string"},"description":{"type":"string"},"quantityBefore":{"type":["number","null"]},"quantityAfter":{"type":["number","null"]},"before":{"type":"number"},"after":{"type":"number"},"amount":{"type":"number"}},"required":["item","meter","product","description","quantityBefore","quantityAfter","before","after","amount"]}},"before":{"type":"object","properties":{"total":{"type":"number"},"gstIncluded":{"type":"number"}},"required":["total","gstIncluded"]},"after":{"type":"object","properties":{"total":{"type":"number"},"gstIncluded":{"type":"number"}},"required":["total","gstIncluded"]},"difference":{"type":"object","properties":{"total":{"type":"number"},"gstIncluded":{"type":"number"}},"required":["total","gstIncluded"]},"gstRegistered":{"type":"boolean"},"gstSays":{"type":"string"},"changed":{"type":"array","items":{"type":"string"}},"payTo":{},"payToSays":{},"notes":{"type":"array","items":{"type":"string"}},"forCreditcrest":{"type":"array","items":{"type":"string"}},"standing":{"type":"object","properties":{"number":{"type":"string"},"title":{"type":"string"},"status":{"type":"string"},"month":{"type":"string"},"period":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]},"issuedOn":{"type":"string"},"dueOn":{"type":"string"},"paymentDays":{"type":"number"},"seller":{"type":"object","properties":{"name":{"type":"string"},"abn":{"type":"string"}},"required":["name","abn"]},"buyer":{"type":"object","properties":{"lender":{"type":"string"},"legalName":{"type":"string"},"abn":{"type":"string"}},"required":["lender","legalName","abn"]},"currency":{"type":"string"},"summary":{"type":"object","properties":{"perDecision":{"type":"number"},"onAdvances":{"type":"number"},"checks":{"type":"number"},"discounts":{"type":"number"},"launch":{"type":"number"},"total":{"type":"number"},"funded":{"type":"number"},"perFundedLoan":{"type":"number"}},"required":["perDecision","onAdvances","checks","discounts","launch","total","funded","perFundedLoan"]},"volume":{"type":"object","properties":{"serviceFees":{"type":"number"},"discount":{"type":"number"},"version":{},"workings":{"type":"array"}},"required":["serviceFees","discount","version","workings"]},"lines":{"type":"array","items":{"type":"object","properties":{"item":{"type":"string"},"meter":{"type":"string"},"product":{"type":"string"},"description":{"type":"string"},"quantity":{"type":["number","null"]},"unit":{"type":["number","null"]},"amount":{"type":"number"},"version":{"type":"number"},"share":{"type":"number"},"note":{"type":"string"}},"required":["item","meter","product","description","quantity","unit","amount"]}},"list":{"type":"number"},"total":{"type":"number"},"gstRegistered":{"type":"boolean"},"gstIncluded":{"type":"number"},"gstSays":{"type":"string"},"launch":{"type":["object","null"],"properties":{"month":{"type":"number"},"signedOn":{"type":"string"},"firstMonth":{"type":"string"},"discount":{"type":"number"},"deferred":{"type":"number"},"repaid":{"type":"number"},"part":{},"of":{"type":"number"},"deferredInMonth1":{},"lockedUntil":{"type":"string"},"says":{"type":"string"},"terms":{"type":"object","properties":{"discount":{"type":"number"},"discountMonths":{"type":"number"},"deferredMonths":{"type":"number"},"repaidOverMonths":{"type":"number"},"priceLockMonths":{"type":"number"}},"required":["discount","discountMonths","deferredMonths","repaidOverMonths","priceLockMonths"]}},"required":["month","signedOn","firstMonth","discount","deferred","repaid","part","of","deferredInMonth1","lockedUntil","says","terms"]},"decisions":{"type":"number"},"services":{"type":"string"},"advances":{"type":"array","items":{"type":"object","properties":{"loan":{"type":"string"},"at":{"type":"string"},"on":{"type":"string"},"cents":{"type":"number"},"amount":{"type":"number"},"fee":{"type":"number"},"workings":{"type":"array","items":{"type":"object","properties":{"from":{"type":"number"},"to":{"type":"number"},"rate":{"type":"number"},"amount":{"type":"number"}},"required":["from","to","rate","amount"]}},"version":{"type":"number"},"returned":{"type":"boolean"}},"required":["loan","at","on","cents","amount","fee","workings","version","returned"]}},"credits":{"type":"array"},"takeRateShare":{"type":"number"},"prices":{"type":"object","properties":{"signed":{"type":"number"},"version":{"type":"number"},"since":{},"lower":{"type":"array"},"lockedUntil":{"type":"string"},"pending":{"type":"array","items":{"type":"object","properties":{"version":{"type":"number"},"published":{"type":"string"},"effective":{"type":"string"},"raises":{"type":"boolean"},"appliesFrom":{"type":"string"}},"required":["version","published","effective","raises","appliesFrom"]}},"bands":{"type":"array","items":{"type":"object","properties":{"upTo":{"type":["number","null"]},"rate":{"type":"number"}},"required":["upTo","rate"]}}},"required":["signed","version","since","lower","lockedUntil","pending","bands"]},"payTo":{},"payToSays":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}},"problems":{"type":"array"},"forCreditcrest":{"type":"array","items":{"type":"string"}},"notBilled":{"type":"array"},"usage":{"type":"object","properties":{"counts":{"type":"array","items":{"type":"object","properties":{"item":{"type":"string"},"mode":{"type":"string"},"status":{"type":["number","null"]},"count":{"type":"number"}},"required":["item","mode","status","count"]}},"notBilled":{"type":"array"},"nothingToCredit":{"type":"array"},"covers":{"type":"string"},"notCovered":{"type":"string"}},"required":["counts","notBilled","nothingToCredit","covers","notCovered"]}},"required":["number","title","status","month","period","issuedOn","dueOn","paymentDays","seller","buyer","currency","summary","volume","lines","list","total","gstRegistered","gstIncluded","gstSays","launch","decisions","services","advances","credits","takeRateShare","prices","payTo","payToSays","notes","problems","forCreditcrest","notBilled","usage"]}},"required":["number","title","kind","status","month","period","issuedOn","dueOn","paymentDays","adjusts","replaces","reason","seller","buyer","currency","lines","before","after","difference","gstRegistered","gstSays","changed","payTo","payToSays","notes","forCreditcrest","standing"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"admin":[]}]}},"/v1/l/{tenant}/book/funder":{"get":{"operationId":"getLTenantBookFunder","tags":["Book and reports"],"summary":"The funder pack for a lender whose records Creditcrest keeps","description":"The funder pack for a lender whose records Creditcrest keeps: loan tape, borrowing base, vintage curves, roll rates, complaints and refunds. Needs that lender’s API key.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/growth#get-v1-l-tenant-book-funder"},"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"asAt","in":"query","required":false,"description":"YYYY-MM-DD, the as-at day; today in Sydney if left out","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"report":{"type":"string"},"version":{"type":"string"},"lender":{"type":"string"},"asAt":{"type":"string"},"units":{"type":"object","properties":{"money":{"type":"string"},"rates":{"type":"string"}},"required":["money","rates"]},"month":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]},"loanTape":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"kind":{"type":"string"},"status":{"type":"string"},"writtenOff":{"type":"number"},"writtenOffHardshipRelief":{"type":"number"},"writtenOffOn":{"type":["string","null"]},"writeOff":{"type":["string","null"]},"hardshipRequestPendingUntil":{"type":["string","null"]},"advancedOn":{"type":"string"},"advanced":{"type":"number"},"principalOutstanding":{"type":"number"},"outstanding":{"type":"number"},"arrears":{"type":"number"},"daysPastDue":{"type":"number"},"worstDaysPastDue":{"type":"number"},"inHardship":{"type":"boolean"},"lastPaymentOn":{"type":["string","null"]},"nextDueOn":{"type":["string","null"]},"asAt":{"type":"string"},"riskClass":{"type":["string","null"]},"riskClassAtApplication":{"type":["string","null"]},"riskScale":{"type":["string","null"]}},"required":["reference","kind","status","writtenOff","writtenOffHardshipRelief","writtenOffOn","writeOff","hardshipRequestPendingUntil","advancedOn","advanced","principalOutstanding","outstanding","arrears","daysPastDue","worstDaysPastDue","inHardship","lastPaymentOn","nextDueOn","asAt","riskClass","riskClassAtApplication","riskScale"]}},"riskClasses":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"riskClass":{"type":["string","null"]},"scale":{"type":["string","null"]},"label":{"type":"string"},"pd":{"type":["object","null"],"properties":{"from":{"type":"number"},"to":{"type":"number"}},"required":["from","to"]},"loans":{"type":"number"},"principalCents":{"type":"number"},"arrearsCents":{"type":"number"},"writtenOffCents":{"type":"number"}},"required":["riskClass","scale","label","pd","loans","principalCents","arrearsCents","writtenOffCents"]}},"loans":{"type":"number"},"plain":{"type":"number"},"says":{"type":"string"}},"required":["rows","loans","plain","says"]},"borrowingBase":{"type":"object","properties":{"receivables":{"type":"number"},"eligible":{"type":"number"},"ineligible":{"type":"array"},"eligiblePrincipal":{"type":"number"},"advanceRate":{},"available":{},"triggers":{"type":"array"},"breached":{"type":"boolean"},"says":{"type":"string"}},"required":["receivables","eligible","ineligible","eligiblePrincipal","advanceRate","available","triggers","breached","says"]},"vintageCurves":{"type":"object","properties":{"version":{"type":"string"},"asAt":{"type":"string"},"fpdDays":{"type":"number"},"everDays":{"type":"number"},"vintages":{"type":"array","items":{"type":"object","properties":{"vintage":{"type":"string"},"accounts":{"type":"number"},"advanced":{"type":"number"},"writtenOff":{"type":"number"},"hardshipRelief":{"type":"number"},"recovered":{"type":"number"},"netLoss":{"type":"number"},"netLossRate":{"type":"number"},"curve":{"type":"array","items":{"type":"object","properties":{"mob":{"type":"number"},"on":{"type":"string"},"partial":{"type":"boolean"},"writtenOff":{"type":"number"},"hardshipRelief":{"type":"number"},"recovered":{"type":"number"},"netLoss":{"type":"number"},"netLossRate":{"type":"number"}},"required":["mob","on","partial","writtenOff","hardshipRelief","recovered","netLoss","netLossRate"]}},"firstPaymentDefault":{"type":"object","properties":{"measured":{"type":"number"},"defaults":{"type":"number"},"rate":{"type":["number","null"]},"notYet":{"type":"number"},"unmeasured":{"type":"number"}},"required":["measured","defaults","rate","notYet","unmeasured"]},"ever30":{"type":"object","properties":{"seasoned":{"type":"number"},"accounts":{"type":"number"},"rate":{"type":["number","null"]}},"required":["seasoned","accounts","rate"]}},"required":["vintage","accounts","advanced","writtenOff","hardshipRelief","recovered","netLoss","netLossRate","curve","firstPaymentDefault","ever30"]}},"says":{"type":"string"}},"required":["version","asAt","fpdDays","everDays","vintages","says"]},"rolls":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"matrix":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"number"}}},"unmatched":{"type":"number"},"says":{}},"required":["from","to","matrix","unmatched","says"]},"complaints":{"type":"object","properties":{"inMonth":{"type":"number"},"toDate":{"type":"number"}},"required":["inMonth","toDate"]},"refunds":{"type":"object","properties":{"inMonth":{"type":"object","properties":{"count":{"type":"number"},"amount":{"type":"number"}},"required":["count","amount"]},"toDate":{"type":"object","properties":{"count":{"type":"number"},"amount":{"type":"number"}},"required":["count","amount"]}},"required":["inMonth","toDate"]},"problems":{"type":"array"},"mode":{"type":"string"},"could_not_read":{"type":"array"}},"required":["report","version","lender","asAt","units","month","loanTape","riskClasses","borrowingBase","vintageCurves","rolls","complaints","refunds","problems","mode","could_not_read"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/l/{tenant}/loans":{"get":{"operationId":"getLTenantLoans","tags":["LoanManager"],"summary":"Every funded loan, as the LoanManager dashboard lists it","description":"Every funded loan, as the LoanManager dashboard lists it: balance, days past due and band, risk class, hardship and flags, with the portfolio’s tiles. Needs that lender’s API key.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#get-v1-l-tenant-loans"},"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"open | current | arrears | hardship | closed | paid-out | written-off | written-off-hardship","schema":{"type":"string"}},{"name":"band","in":"query","required":false,"description":"current | 1-30 | 31-60 | 61-90 | 91-120 | 120+","schema":{"type":"string"}},{"name":"hardship","in":"query","required":false,"description":"request | undecided | arrangement | any | ever | none","schema":{"type":"string"}},{"name":"product","in":"query","required":false,"description":"a product key","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"a loan or application reference, customer id, name or mobile","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"priority | dpd | balance | principal | next | risk | borrower | reference","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"from 1, 25 loans a page","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"lender":{"type":"string"},"mode":{"type":"string"},"asAt":{"type":"string"},"tiles":{"type":"object","properties":{"asAt":{"type":"string"},"month":{"type":"string"},"active":{"type":"number"},"current":{"type":"number"},"principalOutstandingCents":{"type":"number"},"balanceCents":{"type":"number"},"arrears":{"type":"object","properties":{"loans":{"type":"number"},"cents":{"type":"number"}},"required":["loans","cents"]},"bands":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"colour":{"type":"string"},"text":{"type":"string"},"loans":{"type":"number"},"arrearsCents":{"type":"number"},"balanceCents":{"type":"number"}},"required":["key","label","colour","text","loans","arrearsCents","balanceCents"]}},"arrangements":{"type":"object","properties":{"running":{"type":"number"},"missed":{"type":"number"},"endingSoon":{"type":"number"}},"required":["running","missed","endingSoon"]},"requests":{"type":"object","properties":{"pending":{"type":"number"},"decideBy":{},"undecided":{"type":"number"}},"required":["pending","decideBy","undecided"]},"paidOutThisMonth":{"type":"object","properties":{"loans":{"type":"number"}},"required":["loans"]},"writtenOff":{"type":"object","properties":{"loans":{"type":"number"},"cents":{"type":"number"}},"required":["loans","cents"]},"writtenOffHardship":{"type":"object","properties":{"loans":{"type":"number"},"cents":{"type":"number"}},"required":["loans","cents"]},"statementsOwed":{"type":"number"}},"required":["asAt","month","active","current","principalOutstandingCents","balanceCents","arrears","bands","arrangements","requests","paidOutThisMonth","writtenOff","writtenOffHardship","statementsOwed"]},"filters":{"type":"object","properties":{"q":{"type":"string"},"status":{"type":"string"},"band":{"type":"string"},"hardship":{"type":"string"},"product":{"type":"string"},"sort":{"type":"string"},"dir":{"type":"string"},"page":{"type":"number"}},"required":["q","status","band","hardship","product","sort","dir","page"]},"matched":{"type":"number"},"page":{"type":"number"},"pages":{"type":"number"},"loans":{"type":"array"},"could_not_read":{"type":"array"}},"required":["lender","mode","asAt","tiles","filters","matched","page","pages","loans","could_not_read"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/l/{tenant}/loans/{loanRef}":{"get":{"operationId":"getLTenantLoansLoanRef","tags":["LoanManager"],"summary":"One loan","description":"One loan: its account as the ledger runs it today — schedule, every transaction with its allocations, balances, payout figure, hardship — with its repayment history month by month, its score history and the borrower’s requests. Needs that lender’s API key.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#get-v1-l-tenant-loans-loanref"},"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"loanRef","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"lender":{"type":"string"},"mode":{"type":"string"},"reference":{"type":"string"},"application":{"type":"string"},"customerId":{"type":"string"},"borrower":{"type":"string"},"product":{"type":"string"},"contract":{"type":"object","properties":{"state":{"type":"string"},"words":{"type":"string"},"fundedOn":{"type":"string"}},"required":["state","words","fundedOn"]},"asAt":{"type":"string"},"status":{"type":"string"},"band":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"colour":{"type":"string"},"text":{"type":"string"}},"required":["key","label","colour","text"]},"riskClass":{"type":"string"},"riskClassAtApplication":{"type":"string"},"account":{"type":"object","properties":{"status":{"type":"string"},"balances":{"type":"object","properties":{"principal":{"type":"number"},"establishmentFee":{"type":"number"},"monthlyFee":{"type":"number"},"interest":{"type":"number"},"otherFee":{"type":"number"},"dishonourFee":{"type":"number"},"collectionFee":{"type":"number"},"outstanding":{"type":"number"},"unappliedCredit":{"type":"number"},"net":{"type":"number"}},"required":["principal","establishmentFee","monthlyFee","interest","otherFee","dishonourFee","collectionFee","outstanding","unappliedCredit","net"]},"arrears":{"type":"object","properties":{"arrears":{"type":"number"},"oldestUnpaid":{},"contractualDays":{"type":"number"},"pausedDays":{"type":"number"},"daysPastDue":{"type":"number"},"frozen":{},"method":{"type":"string"},"accountCharges":{"type":"number"}},"required":["arrears","oldestUnpaid","contractualDays","pausedDays","daysPastDue","frozen","method","accountCharges"]},"payout":{"type":"object","properties":{"on":{"type":"string"},"amount":{"type":"number"},"lines":{"type":"array","items":{"type":"object","properties":{"what":{"type":"string"},"amount":{"type":"number"}},"required":["what","amount"]}},"leavesOut":{"type":"string"},"cite":{"type":"string"},"rule":{"type":"string"},"mayChange":{"type":"string"}},"required":["on","amount","lines","leavesOut","cite","rule","mayChange"]},"rows":{"type":"array","items":{"type":"object","properties":{"n":{"type":"number"},"due":{"type":"string"},"scheduled":{"type":"object","properties":{"principal":{"type":"number"},"establishmentFee":{"type":"number"},"monthlyFee":{"type":"number"},"interest":{"type":"number"},"otherFee":{"type":"number"}},"required":["principal","establishmentFee","monthlyFee","interest","otherFee"]},"owed":{"type":"object","properties":{"principal":{"type":"number"},"establishmentFee":{"type":"number"},"monthlyFee":{"type":"number"},"interest":{"type":"number"},"otherFee":{"type":"number"}},"required":["principal","establishmentFee","monthlyFee","interest","otherFee"]},"satisfied":{"type":"object","properties":{"principal":{"type":"number"},"establishmentFee":{"type":"number"},"monthlyFee":{"type":"number"},"interest":{"type":"number"},"otherFee":{"type":"number"}},"required":["principal","establishmentFee","monthlyFee","interest","otherFee"]},"unpaid":{"type":"number"},"cashPaid":{"type":"number"},"held":{"type":"number"},"status":{"type":"string"},"notCharged":{}},"required":["n","due","scheduled","owed","satisfied","unpaid","cashPaid","held","status","notCharged"]}},"transactions":{"type":"array","items":{"type":"object","properties":{"seq":{"type":"number"},"on":{"type":"string"},"type":{"type":"string"},"debit":{"type":"number"},"credit":{"type":"number"},"allocations":{"type":"array","items":{"type":"object","properties":{"row":{"type":["number","null"]},"charge":{},"part":{"type":"string"},"kind":{"type":"string"},"amount":{"type":"number"}},"required":["row","charge","part","kind","amount"]}},"event":{"type":["string","null"]},"reverses":{},"reason":{"type":["string","null"]},"by":{"type":["string","null"]},"method":{"type":["string","null"]},"reference":{"type":["string","null"]},"outstanding":{"type":"number"},"unappliedCredit":{"type":"number"},"txRef":{"type":"string"},"recordedBy":{"type":["string","null"]},"recordedAt":{"type":["string","null"]}},"required":["seq","on","type","debit","credit","allocations","event","reverses","reason","by","method","reference","outstanding","unappliedCredit","txRef","recordedBy","recordedAt"]}},"hardship":{"type":"array"},"hardshipPending":{"type":"array"},"hardshipRequest":{},"writeOff":{},"afterSchedule":{"type":"object","properties":{"lastDue":{"type":"string"},"since":{},"running":{"type":"boolean"},"basis":{},"feeName":{},"monthlyFee":{},"rows":{"type":"array"},"months":{},"charged":{"type":"number"},"says":{},"cite":{}},"required":["lastDue","since","running","basis","feeName","monthlyFee","rows","months","charged","says","cite"]},"findings":{"type":"array"},"problems":{"type":"array"}},"required":["status","balances","arrears","payout","rows","transactions","hardship","hardshipPending","hardshipRequest","writeOff","afterSchedule","findings","problems"]},"repaymentHistory":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string"},"rhi":{"type":"string"},"fhi":{},"daysOverdue":{"type":"number"},"basis":{"type":"string"}},"required":["month","rhi","fhi","daysOverdue","basis"]}},"scoreHistory":{"type":"array","items":{"type":"object","properties":{"on":{"type":"string"},"reason":{"type":"string"},"change":{"type":["number","null"]},"after":{"type":"number"},"riskClass":{"type":"string"},"says":{"type":["string","null"]}},"required":["on","reason","change","after","riskClass","says"]}},"requests":{"type":"object","properties":{"payments":{"type":"array","items":{"type":"object","properties":{"seq":{"type":"number"},"requestedOn":{"type":"string"},"requestedAt":{"type":"string"},"mode":{"type":"string"},"amount":{"type":"number"},"method":{"type":"string"},"state":{"type":"string"},"outcome":{"type":"object","properties":{"seq":{"type":"number"},"on":{"type":"string"},"reference":{"type":"string"},"reason":{}},"required":["seq","on","reference","reason"]}},"required":["seq","requestedOn","requestedAt","mode","amount","method","state","outcome"]}},"hardshipNotices":{"type":"array"},"complaints":{"type":"array"},"payoutStatements":{"type":"object","properties":{"requested":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"requestedOn":{"type":"string"},"due":{"type":"string"},"issued":{"type":"boolean"}},"required":["reference","requestedOn","due","issued"]}},"issued":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"asAt":{"type":"string"},"amount":{"type":"number"},"issuedOn":{"type":"string"}},"required":["reference","asAt","amount","issuedOn"]}}},"required":["requested","issued"]}},"required":["payments","hardshipNotices","complaints","payoutStatements"]},"lastSeq":{"type":"number"},"requestsSeq":{"type":"number"}},"required":["lender","mode","reference","application","customerId","borrower","product","contract","asAt","status","band","riskClass","riskClassAtApplication","account","repaymentHistory","scoreHistory","requests","lastSeq","requestsSeq"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/l/{tenant}/applications":{"post":{"operationId":"postLTenantApplications","tags":["Hosted Application"],"summary":"Submit a whole application","description":"Submit a whole application: the same checks as the hosted pages, the answers sealed, the lender’s policy run for its staff, and the case put in its queue. Returns the reference and nothing about the outcome.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/journey#post-v1-l-tenant-applications"},"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{start, contact: {email, mobile, emailToken?, mobileToken?}, about, statement: {csv} | {later: true}, finances, consents: {key: true}, declaration: true}","content":{"application/json":{"schema":{"type":"object","description":"{start, contact: {email, mobile, emailToken?, mobileToken?}, about, statement: {csv} | {later: true}, finances, consents: {key: true}, declaration: true}"}}}},"responses":{"201":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"reference":{"type":"string"},"status":{"type":"string"},"not_a_decision":{"type":"string"}},"required":["reference","status","not_a_decision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/l/{tenant}/requests/{loanRef}":{"get":{"operationId":"getLTenantRequestsLoanRef","tags":["LoanManager"],"summary":"What a borrower asked for on a loan","description":"What a borrower asked for on a loan: payments with their state (processing, settled or returned), hardship notices, complaints and payout statements.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#get-v1-l-tenant-requests-loanref"},"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"loanRef","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"reference":{"type":"string"},"mode":{"type":"string"},"payments":{"type":"array","items":{"type":"object","properties":{"seq":{"type":"number"},"requestedOn":{"type":"string"},"requestedAt":{"type":"string"},"mode":{"type":"string"},"amount":{"type":"number"},"method":{"type":"string"},"state":{"type":"string"},"outcome":{"type":"object","properties":{"seq":{"type":"number"},"on":{"type":"string"},"reference":{"type":"string"},"reason":{"type":["string","null"]}},"required":["seq","on","reference","reason"]}},"required":["seq","requestedOn","requestedAt","mode","amount","method","state","outcome"]}},"hardshipNotices":{"type":"array"},"complaints":{"type":"array"},"payoutStatements":{"type":"array"}},"required":["reference","mode","payments","hardshipNotices","complaints","payoutStatements"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/l/{tenant}/support/{reference}":{"get":{"operationId":"getLTenantSupportReference","tags":["LoanManager"],"summary":"A hardship notice or complaint given on the support page, by its acknowledgement reference","description":"A hardship notice or complaint given on the support page, by its acknowledgement reference: what was asked, and the name and contact to reply to. The loan reference is as the person typed it, for the lender to match.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#get-v1-l-tenant-support-reference"},"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"reference","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"reference":{"type":"string"},"mode":{"type":"string"},"received":{"type":"array","items":{"type":"object","properties":{"receivedAt":{"type":"string"},"receivedOn":{"type":"string"},"channel":{"type":"string"},"reasons":{"type":"array","items":{"type":"string"}},"given":{"type":"array","items":{"type":"string"}},"when":{},"contactPreference":{},"statedReason":{},"acknowledgement":{"type":"string"},"name":{"type":"string"},"contact":{"type":"string"},"loanReference":{"type":"string"},"signedIn":{"type":"boolean"},"type":{"type":"string"},"seq":{"type":"number"},"at":{"type":"string"},"actor":{"type":"string"},"on":{"type":"string"}},"required":["receivedAt","receivedOn","channel","reasons","given","when","contactPreference","statedReason","acknowledgement","name","contact","loanReference","signedIn","type","seq","at","actor","on"]}}},"required":["reference","mode","received"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/l/{tenant}/requests/{loanRef}/settle":{"post":{"operationId":"postLTenantRequestsLoanRefSettle","tags":["LoanManager"],"summary":"Settle or return a payment a borrower asked for","description":"Settle or return a payment a borrower asked for. Settled, it becomes the payment on the account, once, whatever the number of times it is sent.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#post-v1-l-tenant-requests-loanref-settle"},"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"loanRef","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requestSeq":{"description":"the seq of the payment requested event"},"outcome":{"description":"settled | returned"},"reference":{"description":"the payment’s reference in the lender’s system"},"on":{"description":"YYYY-MM-DD, the day; today in Sydney if left out"},"reason":{"description":"for a return, why"}}}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"reference":{"type":"string"},"request":{"type":"object","properties":{"seq":{"type":"number"},"requestedOn":{"type":"string"},"requestedAt":{"type":"string"},"mode":{"type":"string"},"amount":{"type":"number"},"method":{"type":"string"},"state":{"type":"string"},"outcome":{}},"required":["seq","requestedOn","requestedAt","mode","amount","method","state","outcome"]},"recorded":{"type":"object","properties":{"seq":{"type":"number"},"type":{"type":"string"},"data":{"type":"object","properties":{"requestSeq":{"type":"number"},"on":{"type":"string"},"reference":{"type":"string"},"amount":{"type":"number"},"reason":{"type":"string"}},"required":["requestSeq","on","reference","amount"]}},"required":["seq","type","data"]},"payment":{"type":["object","null"],"properties":{"seq":{"type":"number"},"data":{"type":"object","properties":{"id":{"type":"string"},"on":{"type":"string"},"amount":{"type":"number"},"method":{"type":"string"},"reference":{"type":"string"}},"required":["id","on","amount","method","reference"]}},"required":["seq","data"]}},"required":["ok","reference","request","recorded","payment"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/l/{tenant}/day":{"post":{"operationId":"postLTenantDay","tags":["LoanManager"],"summary":"The daily run","description":"The daily run: seals the day before for every funded account, and lists the debits, hardship and complaint deadlines, payout statements, processing payments and messages due. Where the lender’s payments are connected (Zepto, with payment collection allowed), each repayment due today on a loan whose borrower authorised a PayTo agreement is collected — never more than the ledger says is owed that day, one at a time — and goes on the ledger when Zepto reports it settled. It sends nothing else.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#post-v1-l-tenant-day"},"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"asAt":{"description":"YYYY-MM-DD; today in Sydney if left out. A run for an earlier day lists what fell due then and collects nothing."}}}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"tenant":{"type":"string"},"asAt":{"type":"string"},"closedThrough":{"type":"string"},"closed":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"through":{"type":"string"},"recorded":{"type":"boolean"},"hash":{"type":"string"},"transactions":{"type":"number"},"already":{"type":"boolean"},"agrees":{"type":"boolean"},"says":{"type":"string"},"paidOut":{"type":"string"}},"required":["reference","through","recorded"]}},"accounts":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"status":{"type":"string"},"owed":{"type":"number"},"arrears":{"type":"number"},"daysPastDue":{"type":"number"},"band":{"type":"string"},"payout":{"type":"number"},"hardshipRequest":{"type":["object","null"],"properties":{"pendingUntil":{"type":"string"},"says":{"type":"string"}},"required":["pendingUntil","says"]}},"required":["reference","status","owed","arrears","daysPastDue","band","payout","hardshipRequest"]}},"debits":{"type":"object","properties":{"ok":{"type":"boolean"},"on":{"type":"string"},"instructions":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"on":{"type":"string"},"amount":{"type":"number"},"rows":{"type":"array","items":{"type":"number"}},"bsb":{"type":"string"},"account":{"type":"string"},"name":{"type":"string"},"code":{"type":"number"},"evidence":{"type":"array","items":{"type":"string"}},"method":{"type":"string"},"collection":{"type":"object","properties":{"asked":{"type":"boolean"},"instruction":{"type":["string","null"]},"state":{"type":"string"},"says":{"type":"string"},"code":{"type":"string"},"why":{"type":"string"}},"required":["asked"]}},"required":["reference","on","amount","rows","bsb","account","name","code","evidence","method","collection"]}},"skipped":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"amount":{"type":"number"},"why":{"type":"string"},"payTo":{"type":"string"}},"required":["reference","amount","why"]}},"total":{"type":"number"},"says":{"type":"string"},"notADecision":{"type":"string"}},"required":["ok","on","instructions","skipped","total","says","notADecision"]},"notices":{"type":"object","properties":{"fed":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"notice":{"type":"string"},"receivedOn":{"type":"string"},"source":{"type":"string"}},"required":["reference","notice","receivedOn","source"]}}},"required":["fed"]},"deadlines":{"type":"object","properties":{"hardship":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"source":{"type":"string"},"acknowledgement":{"type":"string"},"receivedOn":{"type":"string"},"obligation":{"type":"string"},"what":{"type":"string"},"due":{"type":"string"},"status":{"type":"string"},"cite":{"type":"string"}},"required":["reference","source","acknowledgement","receivedOn","obligation","what","due","status","cite"]}},"complaints":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"source":{"type":"string"},"acknowledgement":{"type":"string"},"receivedOn":{"type":"string"},"what":{"type":"string"},"due":{"type":"string"},"status":{"type":"string"},"cite":{"type":"string"}},"required":["reference","source","acknowledgement","receivedOn","what","due","status","cite"]}},"payoutStatements":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"request":{"type":"string"},"requestedOn":{"type":"string"},"asAt":{"type":"string"},"due":{"type":"string"},"status":{"type":"string"}},"required":["reference","request","requestedOn","asAt","due","status"]}}},"required":["hardship","complaints","payoutStatements"]},"payments":{"type":"object","properties":{"processing":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"requestSeq":{"type":"number"},"amount":{"type":"number"},"mode":{"type":"string"},"requestedOn":{"type":"string"}},"required":["reference","requestSeq","amount","mode","requestedOn"]}}},"required":["processing"]},"messages":{"type":"object","properties":{"due":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"journey":{"type":"string"},"channel":{"type":"string"},"step":{"type":"number"},"purpose":{"type":"string"},"rule":{"type":"string"}},"required":["reference","journey","channel","step","purpose","rule"]}},"held":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"journey":{"type":"string"},"why":{"type":"string"}},"required":["reference","journey","why"]}}},"required":["due","held"]},"problems":{"type":"array"},"score":{"type":"object","properties":{"changes":{"type":"number"},"loans":{"type":"number"},"counted":{"type":"number"},"problems":{"type":"array"},"modelBorrower":{"type":["object","null"],"properties":{"name":{"type":"string"},"rating":{"type":"number"}},"required":["name","rating"]}},"required":["changes","loans","counted","problems","modelBorrower"]},"sends":{"type":"string"},"movesMoney":{"type":"boolean"},"collection":{"type":"object","properties":{"allowed":{"type":"boolean"},"why":{"type":["string","null"]},"provider":{"type":"string"},"sandbox":{"type":"boolean"},"asked":{"type":"number"},"held":{"type":"number"}},"required":["allowed","why","provider","sandbox","asked","held"]},"says":{"type":"string"},"mode":{"type":"string"}},"required":["ok","tenant","asAt","closedThrough","closed","accounts","debits","notices","deadlines","payments","messages","problems","score","sends","movesMoney","collection","says","mode"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/l/{tenant}/staff-sessions":{"post":{"operationId":"postLTenantStaffSessions","tags":["Operations"],"summary":"A sign-in link to the lender’s operations console for one of its staff, lasting ten minutes and…","description":"A sign-in link to the lender’s operations console for one of its staff, lasting ten minutes and working once. The lender’s own key is needed outside the sandbox. Send a name and a role; or the work email of a person on the lender’s staff list, to sign them in as the list has them — the way in before sign-in links can be emailed, and how a person adds their first passkey then.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/operations#post-v1-l-tenant-staff-sessions"},"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"the staff member’s full name, as it will appear on every change they make"},"role":{"description":"assessor | senior | compliance | admin | auditor"},"email":{"description":"or: the work email of an active person on the lender’s staff list"}}}}}},"responses":{"201":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string"},"expires":{"type":"string"},"oneTime":{"type":"boolean"},"name":{"type":"string"},"role":{"type":"string"},"mode":{"type":"string"},"note":{"type":"string"}},"required":["link","expires","oneTime","name","role","mode","note"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/statement":{"get":{"operationId":"getStatement","tags":["Statement"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/statement#get-v1-statement"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"stores":{"type":"string"},"reads":{"type":"array","items":{"type":"string"}},"endpoints":{"type":"object","additionalProperties":{"type":"object","properties":{"what":{"type":"string"},"body":{"type":"string"},"query":{"type":"object","properties":{"setting":{"type":"object","properties":{"what":{"type":"string"},"takes":{"type":"array","items":{"type":"string"}}},"required":["what","takes"]},"example":{"type":"string"}}}},"required":["what"]}},"settings":{"type":"array","items":{"type":"object","properties":{"setting":{"type":"string"},"default":{"type":"boolean"},"target":{"type":["number","null"]},"modelled":{"type":"boolean"},"says":{"type":"string"}},"required":["setting","default","target","modelled","says"]}},"default_setting":{"type":"string"}},"required":["service","version","stores","reads","endpoints","settings","default_setting"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]},"post":{"operationId":"postStatement","tags":["Statement"],"summary":"A bank statement read","description":"A bank statement read: income, commitments, expenses and the signals an assessor should be told, each with the transactions behind it.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/statement#post-v1-statement"},"parameters":[{"name":"setting","in":"query","required":false,"description":"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%. Any case; every answer says which it was read under","schema":{"type":"string","enum":["strict","balanced","broad"]}},{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"the CSV export as text/csv, or JSON {statement, holders?, declaredIncome?, declaredIncomeSource?, setting?} plus any capacity field. holders is the account holders’ names, comma-separated: a transfer to or from one of them under their own name is read as their own money moving. setting is strict, balanced (the default) or broad, in the body or the query; the body wins. Used for the reading and not kept.","content":{"application/json":{"schema":{"type":"object","description":"the CSV export as text/csv, or JSON {statement, holders?, declaredIncome?, declaredIncomeSource?, setting?} plus any capacity field. holders is the account holders’ names, comma-separated: a transfer to or from one of them under their own name is read as their own money moving. setting is strict, balanced (the default) or broad, in the body or the query; the body wins. Used for the reading and not kept."}},"text/csv":{"schema":{"type":"string","description":"The bank’s CSV export, as it was downloaded."}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"},"source":{"type":"string"},"sample":{},"reference":{"type":"string"},"format":{},"parse":{"type":"object","properties":{"skipped":{"type":"number"},"dayFirst":{"type":"boolean"},"dateEvidence":{"type":"string"},"balanceChain":{},"rows":{"type":"number"},"columns":{"type":"array","items":{"type":"string"}}},"required":["skipped","dayFirst","dateEvidence","balanceChain","rows","columns"]},"warnings":{"type":"array","items":{"type":"string"}},"setting":{"type":"object","properties":{"name":{"type":"string"},"target":{"type":["number","null"]},"floor":{"type":"number"},"modelled":{"type":"boolean"},"says":{"type":"string"}},"required":["name","target","floor","modelled","says"]},"reading":{"type":"object","properties":{"version":{"type":"string"},"period":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"days":{"type":"number"},"months":{"type":"number"}},"required":["from","to","days","months"]},"quality":{"type":"object","properties":{"transactions":{"type":"number"},"categorised":{"type":"number"},"categorisedShare":{"type":"number"},"spendTotal":{"type":"number"},"spendCategorised":{"type":"number"},"spendCategorisedShare":{"type":"number"},"modelled":{"type":"number"},"spendModelled":{"type":"number"},"spendModelledShare":{"type":"number"},"enoughHistory":{"type":"boolean"}},"required":["transactions","categorised","categorisedShare","spendTotal","spendCategorised","spendCategorisedShare","modelled","spendModelled","spendModelledShare","enoughHistory"]},"income":{"type":"object","properties":{"verifiedMonthly":{"type":"number"},"regular":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"direction":{"type":"string"},"period":{"type":"string"},"confidence":{"type":"number"},"typical":{"type":"number"},"spread":{"type":"number"},"variable":{"type":"boolean"},"assessed":{"type":"number"},"monthly":{"type":"number"},"count":{"type":"number"},"first":{"type":"string"},"last":{"type":"string"},"transactions":{"type":"array","items":{"type":"string"}},"inferred":{"type":"boolean"},"nextExpected":{"type":"string"},"stability":{"type":"object","properties":{"ageDays":{"type":"number"},"expected":{"type":"number"},"received":{"type":"number"},"missed":{"type":"number"},"variation":{"type":"number"},"stopped":{"type":"boolean"},"dueBy":{"type":"string"}},"required":["ageDays","expected","received","missed","variation","stopped","dueBy"]}},"required":["key","description","category","direction","period","confidence","typical","spread","variable","assessed","monthly","count","first","last","transactions","inferred","nextExpected","stability"]}},"otherCredits":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"description":{"type":"string"},"amount":{"type":"number"},"category":{"type":"string"}},"required":["date","description","amount","category"]}},"otherCreditsMonthly":{"type":"number"},"inferredMonthly":{"type":"number"},"stopped":{"type":"array"},"government":{"type":"object","properties":{"byBenefit":{"type":"array"},"socialSecurityPayment":{}},"required":["byBenefit","socialSecurityPayment"]}},"required":["verifiedMonthly","regular","otherCredits","otherCreditsMonthly","inferredMonthly","stopped","government"]},"reconciliation":{"type":"object","properties":{"supplied":{"type":"boolean"},"declared":{},"verified":{"type":"object","properties":{"monthly":{"type":"number"},"credits":{"type":"array","items":{"type":"object","properties":{"payer":{"type":"string"},"amount":{"type":"number"},"cadence":{"type":"string"},"monthly":{"type":"number"},"payments":{"type":"number"},"first":{"type":"string"},"last":{"type":"string"},"payerNamed":{"type":"boolean"},"transactions":{"type":"array","items":{"type":"string"}}},"required":["payer","amount","cadence","monthly","payments","first","last","payerNamed","transactions"]}}},"required":["monthly","credits"]},"difference":{},"shareOfVerified":{},"direction":{},"statement":{"type":"string"},"notAConclusion":{"type":"string"},"explanations":{"type":"array"},"otherCreditsMonthly":{"type":"number"},"differenceCountingOtherCredits":{}},"required":["supplied","declared","verified","difference","shareOfVerified","direction","statement","notAConclusion","explanations","otherCreditsMonthly","differenceCountingOtherCredits"]},"commitments":{"type":"object","properties":{"monthly":{"type":"number"},"housingMonthly":{"type":"number"},"items":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"direction":{"type":"string"},"period":{"type":"string"},"confidence":{"type":"number"},"typical":{"type":"number"},"spread":{"type":"number"},"variable":{"type":"boolean"},"assessed":{"type":"number"},"monthly":{"type":"number"},"count":{"type":"number"},"first":{"type":"string"},"last":{"type":"string"},"transactions":{"type":"array","items":{"type":"string"}},"housing":{"type":"boolean"}},"required":["key","description","category","direction","period","confidence","typical","spread","variable","assessed","monthly","count","first","last","transactions","housing"]}},"subsetOfExpenses":{"type":"boolean"}},"required":["monthly","housingMonthly","items","subsetOfExpenses"]},"expenses":{"type":"object","properties":{"monthly":{"type":"object","properties":{"essential":{"type":"number"},"discretionary":{"type":"number"}},"required":["essential"]},"byCategory":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"},"total":{"type":"number"},"count":{"type":"number"},"transactions":{"type":"array","items":{"type":"string"}},"monthly":{"type":"number"}},"required":["category","label","group","total","count","transactions","monthly"]}}},"required":["monthly","byCategory"]},"outgoings":{"type":"object","properties":{"monthly":{"type":"number"},"excludes":{"type":"array","items":{"type":"string"}}},"required":["monthly","excludes"]},"signals":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"severity":{"type":"string"},"statement":{"type":"string"},"evidence":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"description":{"type":"string"},"amount":{"type":"number"}},"required":["date","description","amount"]}},"count":{"type":"number"}},"required":["code","severity","statement","evidence","count"]}},"recent":{"type":"object","properties":{"asAt":{"type":"string"},"days30":{"type":"object","properties":{"days":{"type":"number"},"from":{"type":"string"},"to":{"type":"string"},"complete":{"type":"boolean"},"covered":{"type":"number"},"income":{"type":"object","properties":{"total":{"type":"number"},"credits":{"type":"number"},"from":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"description":{"type":"string"},"amount":{"type":"number"}},"required":["date","description","amount"]}}},"required":["total","credits","from"]},"gambling":{"type":"object","properties":{"total":{"type":"number"},"shareOfIncome":{"type":"number"},"from":{"type":"array"}},"required":["total","shareOfIncome","from"]},"dishonours":{"type":"object","properties":{"count":{"type":"number"},"from":{"type":"array"}},"required":["count","from"]},"smallAmountCredit":{"type":"object","properties":{"lenders":{"type":"number"},"repayments":{"type":"number"},"from":{"type":"array"}},"required":["lenders","repayments","from"]},"borrowing":{"type":"object","properties":{"count":{"type":"number"},"total":{"type":"number"},"from":{"type":"array"}},"required":["count","total","from"]},"overdrawnDays":{"type":"object","properties":{"count":{},"why":{"type":"string"}},"required":["count","why"]}},"required":["days","from","to","complete","covered","income","gambling","dishonours","smallAmountCredit","borrowing","overdrawnDays"]},"days90":{"type":"object","properties":{"days":{"type":"number"},"from":{"type":"string"},"to":{"type":"string"},"complete":{"type":"boolean"},"covered":{"type":"number"},"income":{"type":"object","properties":{"total":{"type":"number"},"credits":{"type":"number"},"from":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"description":{"type":"string"},"amount":{"type":"number"}},"required":["date","description","amount"]}}},"required":["total","credits","from"]},"gambling":{"type":"object","properties":{"total":{"type":"number"},"shareOfIncome":{"type":"number"},"from":{"type":"array"}},"required":["total","shareOfIncome","from"]},"dishonours":{"type":"object","properties":{"count":{"type":"number"},"from":{"type":"array"}},"required":["count","from"]},"smallAmountCredit":{"type":"object","properties":{"lenders":{"type":"number"},"repayments":{"type":"number"},"from":{"type":"array"}},"required":["lenders","repayments","from"]},"borrowing":{"type":"object","properties":{"count":{"type":"number"},"total":{"type":"number"},"from":{"type":"array"}},"required":["count","total","from"]},"overdrawnDays":{"type":"object","properties":{"count":{},"why":{"type":"string"}},"required":["count","why"]}},"required":["days","from","to","complete","covered","income","gambling","dishonours","smallAmountCredit","borrowing","overdrawnDays"]}},"required":["asAt","days30","days90"]},"review":{"type":"array"},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"string"},"description":{"type":"string"},"amount":{"type":"number"},"balance":{},"row":{"type":"number"},"category":{"type":"string"},"group":{"type":"string"},"label":{"type":"string"},"confidence":{"type":"number"},"matched":{"type":"string"},"rule":{"type":"number"},"normalised":{"type":"string"},"enrichment":{"type":"object","properties":{"category":{"type":"object","properties":{"code":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"},"known":{"type":"boolean"},"detail":{}},"required":["code","label","group","known","detail"]},"thirdParty":{"type":"object","properties":{"name":{"type":["string","null"]},"known":{"type":"boolean"},"basis":{"type":"string"},"identity":{"type":["object","null"],"properties":{"known":{"type":"boolean"},"name":{"type":"string"},"source":{"type":"string"},"fetched":{"type":"string"},"why":{"type":"string"},"abn":{"type":"string"},"acn":{},"industries":{"type":"array","items":{"type":"string"}},"logo":{"type":"string"},"api":{"type":"string"},"updated":{"type":"string"}},"required":["known","name","source","fetched"]},"merchant":{"type":["object","null"],"properties":{"name":{"type":"string"},"key":{"type":"string"},"declared":{"type":"boolean"}},"required":["name","key","declared"]}},"required":["name","known","basis","identity","merchant"]},"confidence":{"type":"object","properties":{"value":{"type":"number"},"band":{"type":"string"},"why":{"type":"string"}},"required":["value","band","why"]},"setting":{"type":"string"},"evidence":{"type":"object","properties":{"description":{"type":"string"},"normalised":{"type":"string"},"matched":{"type":"string"},"direction":{"type":"string"},"rule":{"type":"object","properties":{"index":{"type":"number"},"category":{"type":"string"},"direction":{"type":["string","null"]},"list":{"type":"string"},"line":{}},"required":["index","category","direction","list","line"]}},"required":["description","normalised","matched","direction","rule"]}},"required":["category","thirdParty","confidence","setting","evidence"]}},"required":["id","date","description","amount","balance","row","category","group","label","confidence","matched","rule","normalised","enrichment"]}}},"required":["version","period","quality","income","reconciliation","commitments","expenses","outgoings","signals","recent","review","transactions"]},"asked":{"type":"boolean"},"proposal":{},"options":{},"service":{},"capacity":{},"gaps":{"type":"array"},"problems":{"type":"array"}},"required":["version","source","sample","reference","format","parse","warnings","setting","reading","asked","proposal","options","service","capacity","gaps","problems"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/statement/accuracy":{"get":{"operationId":"getStatementAccuracy","tags":["Statement"],"summary":"How well the reading is measured to be","description":"How well the reading is measured to be: precision, coverage, recall and F1 on each test set, per category and per release.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/statement#get-v1-statement-accuracy"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"measure":{"type":"string"},"headline":{"type":"string"},"setting":{"type":"string"},"settings":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"target":{"type":["number","null"]},"floor":{"type":"number"},"modelled":{"type":"boolean"},"says":{"type":"string"},"default":{"type":"boolean"}},"required":["name","label","target","floor","modelled","says","default"]}},"sets":{"type":"object","properties":{"heldout":{"type":"object","properties":{"label":{"type":"string"},"independent":{"type":"boolean"},"measuredOn":{"type":"string"},"release":{"type":"string"},"lines":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"},"namedShare":{"type":"number"},"silent":{"type":"object","properties":{"lines":{"type":"number"},"answeredAnyway":{"type":"number"}},"required":["lines","answeredAnyway"]},"labelsMoved":{"type":"object","properties":{"liquor":{"type":"number"},"gyms":{"type":"number"},"councils":{"type":"number"},"bakeries":{"type":"number"}},"required":["liquor","gyms","councils","bakeries"]},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"lines":{"type":"number"},"said":{"type":"number"},"saidRight":{"type":"number"},"precision":{"type":"number"},"judged":{"type":"boolean"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"wrongAs":{"type":"object","properties":{"transfer":{"type":"number"},"cash_withdrawal":{"type":"number"},"transport":{"type":"number"},"entertainment":{"type":"number"},"education":{"type":"number"},"housing_mortgage":{"type":"number"}}}},"required":["category","lines","said","saidRight","precision","judged","coverage","recall","f1"]}},"settings":{"type":"object","properties":{"strict":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"},"namedShare":{"type":"number"},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"lines":{"type":"number"},"said":{"type":"number"},"saidRight":{"type":"number"},"read":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"f1":{"type":"number"}},"required":["category","lines","said","saidRight","read","precision","coverage","f1"]}}},"required":["lines","claims","right","precision","coverage","recall","f1","macroF1","namedShare","categories"]},"balanced":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"},"namedShare":{"type":"number"},"modelled":{"type":"object","properties":{"claims":{"type":"number"},"right":{"type":"number"}},"required":["claims","right"]},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"lines":{"type":"number"},"said":{"type":"number"},"saidRight":{"type":"number"},"read":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"f1":{"type":"number"},"modelledSaid":{"type":"number"},"modelledRight":{"type":"number"}},"required":["category","lines","said","saidRight","read","precision","coverage","f1"]}}},"required":["lines","claims","right","precision","coverage","recall","f1","macroF1","namedShare","modelled","categories"]},"broad":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"},"namedShare":{"type":"number"},"modelled":{"type":"object","properties":{"claims":{"type":"number"},"right":{"type":"number"}},"required":["claims","right"]},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"lines":{"type":"number"},"said":{"type":"number"},"saidRight":{"type":"number"},"read":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"f1":{"type":"number"},"modelledSaid":{"type":"number"},"modelledRight":{"type":"number"}},"required":["category","lines","said","saidRight","read","precision","coverage","f1"]}}},"required":["lines","claims","right","precision","coverage","recall","f1","macroF1","namedShare","modelled","categories"]}},"required":["strict","balanced","broad"]},"byHousehold":{"type":"object","properties":{"by":{"type":"string"},"households":{"type":"number"},"cap":{"type":"number"},"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"largest":{"type":"object","properties":{"lines":{"type":"number"},"share":{"type":"number"},"counted":{"type":"number"}},"required":["lines","share","counted"]},"under":{"type":"array"},"modelled":{"type":"object","properties":{"claims":{"type":"number"},"right":{"type":"number"}},"required":["claims","right"]},"settings":{"type":"object","properties":{"strict":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"under":{"type":"array"}},"required":["lines","claims","right","precision","coverage","recall","f1","under"]},"balanced":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"modelled":{"type":"object","properties":{"claims":{"type":"number"},"right":{"type":"number"}},"required":["claims","right"]},"under":{"type":"array"}},"required":["lines","claims","right","precision","coverage","recall","f1","modelled","under"]},"broad":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"modelled":{"type":"object","properties":{"claims":{"type":"number"},"right":{"type":"number"}},"required":["claims","right"]},"under":{"type":"array"}},"required":["lines","claims","right","precision","coverage","recall","f1","modelled","under"]}},"required":["strict","balanced","broad"]}},"required":["by","households","cap","lines","claims","right","precision","coverage","recall","f1","largest","under","modelled","settings"]}},"required":["label","independent","measuredOn","release","lines","precision","coverage","recall","f1","macroF1","namedShare","silent","labelsMoved","categories","settings","byHousehold"]},"payees":{"type":"object","properties":{"label":{"type":"string"},"independent":{"type":"boolean"},"measuredOn":{"type":"string"},"release":{"type":"string"},"lines":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"},"namedShare":{"type":"number"},"silent":{"type":"object","properties":{"lines":{"type":"number"},"answeredAnyway":{"type":"number"}},"required":["lines","answeredAnyway"]},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"lines":{"type":"number"},"said":{"type":"number"},"saidRight":{"type":"number"},"precision":{"type":"number"},"judged":{"type":"boolean"},"coverage":{"type":["number","null"]},"recall":{"type":["number","null"]},"f1":{"type":["number","null"]}},"required":["category","lines","said","saidRight","precision","judged","coverage","recall","f1"]}},"settings":{"type":"object","properties":{"strict":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"},"namedShare":{"type":"number"},"mustNotAnswer":{"type":"object","properties":{"names":{"type":"number"},"answeredAnyway":{"type":"number"}},"required":["names","answeredAnyway"]},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"lines":{"type":"number"},"said":{"type":"number"},"saidRight":{"type":"number"},"read":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":["number","null"]},"f1":{"type":["number","null"]}},"required":["category","lines","said","saidRight","read","precision","coverage","f1"]}}},"required":["lines","claims","right","precision","coverage","recall","f1","macroF1","namedShare","mustNotAnswer","categories"]},"balanced":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"},"namedShare":{"type":"number"},"modelled":{"type":"object","properties":{"claims":{"type":"number"},"right":{"type":"number"}},"required":["claims","right"]},"mustNotAnswer":{"type":"object","properties":{"names":{"type":"number"},"answeredAnyway":{"type":"number"}},"required":["names","answeredAnyway"]},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"lines":{"type":"number"},"said":{"type":"number"},"saidRight":{"type":"number"},"read":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":["number","null"]},"f1":{"type":["number","null"]},"modelledSaid":{"type":"number"},"modelledRight":{"type":"number"}},"required":["category","lines","said","saidRight","read","precision","coverage","f1"]}}},"required":["lines","claims","right","precision","coverage","recall","f1","macroF1","namedShare","modelled","mustNotAnswer","categories"]},"broad":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"},"namedShare":{"type":"number"},"modelled":{"type":"object","properties":{"claims":{"type":"number"},"right":{"type":"number"}},"required":["claims","right"]},"mustNotAnswer":{"type":"object","properties":{"names":{"type":"number"},"answeredAnyway":{"type":"number"}},"required":["names","answeredAnyway"]},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"lines":{"type":"number"},"said":{"type":"number"},"saidRight":{"type":"number"},"read":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":["number","null"]},"f1":{"type":["number","null"]},"modelledSaid":{"type":"number"},"modelledRight":{"type":"number"}},"required":["category","lines","said","saidRight","read","precision","coverage","f1"]}}},"required":["lines","claims","right","precision","coverage","recall","f1","macroF1","namedShare","modelled","mustNotAnswer","categories"]}},"required":["strict","balanced","broad"]}},"required":["label","independent","measuredOn","release","lines","precision","coverage","recall","f1","macroF1","namedShare","silent","categories","settings"]},"wording":{"type":"object","properties":{"label":{"type":"string"},"independent":{"type":"boolean"},"measuredOn":{"type":"string"},"release":{"type":"string"},"lines":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"},"namedShare":{},"silent":{"type":"object","properties":{"lines":{"type":"number"},"answeredAnyway":{"type":"number"}},"required":["lines","answeredAnyway"]},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"lines":{"type":"number"},"said":{"type":"number"},"saidRight":{"type":"number"},"precision":{"type":"number"},"judged":{"type":"boolean"},"coverage":{"type":["number","null"]},"recall":{"type":["number","null"]},"f1":{"type":["number","null"]}},"required":["category","lines","said","saidRight","precision","judged","coverage","recall","f1"]}},"settings":{"type":"object","properties":{"strict":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"lines":{"type":"number"},"said":{"type":"number"},"saidRight":{"type":"number"},"read":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":["number","null"]},"f1":{"type":["number","null"]}},"required":["category","lines","said","saidRight","read","precision","coverage","f1"]}}},"required":["lines","claims","right","precision","coverage","recall","f1","macroF1","categories"]},"balanced":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"},"modelled":{"type":"object","properties":{"claims":{"type":"number"},"right":{"type":"number"}},"required":["claims","right"]},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"lines":{"type":"number"},"said":{"type":"number"},"saidRight":{"type":"number"},"read":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":["number","null"]},"f1":{"type":["number","null"]},"modelledSaid":{"type":"number"},"modelledRight":{"type":"number"}},"required":["category","lines","said","saidRight","read","precision","coverage","f1"]}}},"required":["lines","claims","right","precision","coverage","recall","f1","macroF1","modelled","categories"]},"broad":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"},"modelled":{"type":"object","properties":{"claims":{"type":"number"},"right":{"type":"number"}},"required":["claims","right"]},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"lines":{"type":"number"},"said":{"type":"number"},"saidRight":{"type":"number"},"read":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":["number","null"]},"f1":{"type":["number","null"]},"modelledSaid":{"type":"number"},"modelledRight":{"type":"number"}},"required":["category","lines","said","saidRight","read","precision","coverage","f1"]}}},"required":["lines","claims","right","precision","coverage","recall","f1","macroF1","modelled","categories"]}},"required":["strict","balanced","broad"]}},"required":["label","independent","measuredOn","release","lines","precision","coverage","recall","f1","macroF1","namedShare","silent","categories","settings"]},"billers":{"type":"object","properties":{"label":{"type":"string"},"independent":{"type":"boolean"},"measuredOn":{"type":"string"},"release":{"type":"string"},"lines":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{},"namedShare":{"type":"number"},"silent":{},"categories":{"type":"array"},"settings":{"type":"object","properties":{"strict":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"namedShare":{"type":"number"}},"required":["lines","claims","right","precision","coverage","recall","f1","namedShare"]},"balanced":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"namedShare":{"type":"number"}},"required":["lines","claims","right","precision","coverage","recall","f1","namedShare"]},"broad":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"namedShare":{"type":"number"}},"required":["lines","claims","right","precision","coverage","recall","f1","namedShare"]}},"required":["strict","balanced","broad"]}},"required":["label","independent","measuredOn","release","lines","precision","coverage","recall","f1","macroF1","namedShare","silent","categories","settings"]}},"required":["heldout","payees","wording","billers"]},"releases":{"type":"array","items":{"type":"object","properties":{"ref":{"type":"string"},"on":{"type":"string"},"sets":{"type":"object","properties":{"heldout":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"},"namedShare":{"type":"number"}},"required":["lines","claims","right","precision","coverage","recall","f1","macroF1","namedShare"]},"payees":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"},"namedShare":{"type":"number"}},"required":["lines","claims","right","precision","coverage","recall","f1","macroF1","namedShare"]},"wording":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"macroF1":{"type":"number"}},"required":["lines","claims","right","precision","coverage","recall","f1","macroF1"]},"billers":{"type":"object","properties":{"lines":{"type":"number"},"claims":{"type":"number"},"right":{"type":"number"},"precision":{"type":"number"},"coverage":{"type":"number"},"recall":{"type":"number"},"f1":{"type":"number"},"namedShare":{"type":"number"}},"required":["lines","claims","right","precision","coverage","recall","f1","namedShare"]}},"required":["heldout","payees","wording","billers"]},"title":{"type":"string"},"note":{"type":"string"}},"required":["ref","on","sets","title","note"]}},"definitions":{"type":"object","additionalProperties":{"type":"string"}},"auc":{"type":"string"},"floor":{"type":"number"},"floorFrom":{"type":"number"}},"required":["service","measure","headline","setting","settings","sets","releases","definitions","auc","floor","floorFrom"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/statement/sample":{"get":{"operationId":"getStatementSample","tags":["Statement"],"summary":"The same for an invented statement, so a program can be built before it has anybody’s data","description":"The same for an invented statement, so a program can be built before it has anybody’s data.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/statement#get-v1-statement-sample"},"parameters":[{"name":"example","in":"query","required":false,"description":"which invented statement: ordinary, strained","schema":{"type":"string"}},{"name":"setting","in":"query","required":false,"description":"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%. Any case; every answer says which it was read under","schema":{"type":"string","enum":["strict","balanced","broad"]}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"},"source":{"type":"string"},"sample":{"type":"object","properties":{"key":{"type":"string"},"title":{"type":"string"},"what":{"type":"string"}},"required":["key","title","what"]},"reference":{"type":"string"},"format":{},"parse":{},"warnings":{"type":"array","items":{"type":"string"}},"setting":{"type":"object","properties":{"name":{"type":"string"},"target":{"type":["number","null"]},"floor":{"type":"number"},"modelled":{"type":"boolean"},"says":{"type":"string"}},"required":["name","target","floor","modelled","says"]},"reading":{"type":"object","properties":{"version":{"type":"string"},"period":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"days":{"type":"number"},"months":{"type":"number"}},"required":["from","to","days","months"]},"quality":{"type":"object","properties":{"transactions":{"type":"number"},"categorised":{"type":"number"},"categorisedShare":{"type":"number"},"spendTotal":{"type":"number"},"spendCategorised":{"type":"number"},"spendCategorisedShare":{"type":"number"},"modelled":{"type":"number"},"spendModelled":{"type":"number"},"spendModelledShare":{"type":"number"},"enoughHistory":{"type":"boolean"}},"required":["transactions","categorised","categorisedShare","spendTotal","spendCategorised","spendCategorisedShare","modelled","spendModelled","spendModelledShare","enoughHistory"]},"income":{"type":"object","properties":{"verifiedMonthly":{"type":"number"},"regular":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"direction":{"type":"string"},"period":{"type":"string"},"confidence":{"type":"number"},"typical":{"type":"number"},"spread":{"type":"number"},"variable":{"type":"boolean"},"assessed":{"type":"number"},"monthly":{"type":"number"},"count":{"type":"number"},"first":{"type":"string"},"last":{"type":"string"},"transactions":{"type":"array","items":{"type":"string"}},"inferred":{"type":"boolean"},"nextExpected":{"type":"string"},"stability":{"type":"object","properties":{"ageDays":{"type":"number"},"expected":{"type":"number"},"received":{"type":"number"},"missed":{"type":"number"},"variation":{"type":"number"},"stopped":{"type":"boolean"},"dueBy":{"type":"string"}},"required":["ageDays","expected","received","missed","variation","stopped","dueBy"]}},"required":["key","description","category","direction","period","confidence","typical","spread","variable","assessed","monthly","count","first","last","transactions","inferred","nextExpected","stability"]}},"otherCredits":{"type":"array"},"otherCreditsMonthly":{"type":"number"},"inferredMonthly":{"type":"number"},"stopped":{"type":"array"},"government":{"type":"object","properties":{"byBenefit":{"type":"array"},"socialSecurityPayment":{}},"required":["byBenefit","socialSecurityPayment"]}},"required":["verifiedMonthly","regular","otherCredits","otherCreditsMonthly","inferredMonthly","stopped","government"]},"reconciliation":{"type":"object","properties":{"supplied":{"type":"boolean"},"declared":{},"verified":{"type":"object","properties":{"monthly":{"type":"number"},"credits":{"type":"array","items":{"type":"object","properties":{"payer":{"type":"string"},"amount":{"type":"number"},"cadence":{"type":"string"},"monthly":{"type":"number"},"payments":{"type":"number"},"first":{"type":"string"},"last":{"type":"string"},"payerNamed":{"type":"boolean"},"transactions":{"type":"array","items":{"type":"string"}}},"required":["payer","amount","cadence","monthly","payments","first","last","payerNamed","transactions"]}}},"required":["monthly","credits"]},"difference":{},"shareOfVerified":{},"direction":{},"statement":{"type":"string"},"notAConclusion":{"type":"string"},"explanations":{"type":"array"},"otherCreditsMonthly":{"type":"number"},"differenceCountingOtherCredits":{}},"required":["supplied","declared","verified","difference","shareOfVerified","direction","statement","notAConclusion","explanations","otherCreditsMonthly","differenceCountingOtherCredits"]},"commitments":{"type":"object","properties":{"monthly":{"type":"number"},"housingMonthly":{"type":"number"},"items":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"direction":{"type":"string"},"period":{"type":"string"},"confidence":{"type":"number"},"typical":{"type":"number"},"spread":{"type":"number"},"variable":{"type":"boolean"},"assessed":{"type":"number"},"monthly":{"type":"number"},"count":{"type":"number"},"first":{"type":"string"},"last":{"type":"string"},"transactions":{"type":"array","items":{"type":"string"}},"housing":{"type":"boolean"}},"required":["key","description","category","direction","period","confidence","typical","spread","variable","assessed","monthly","count","first","last","transactions","housing"]}},"subsetOfExpenses":{"type":"boolean"}},"required":["monthly","housingMonthly","items","subsetOfExpenses"]},"expenses":{"type":"object","properties":{"monthly":{"type":"object","properties":{"essential":{"type":"number"},"discretionary":{"type":"number"}},"required":["essential","discretionary"]},"byCategory":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"},"total":{"type":"number"},"count":{"type":"number"},"transactions":{"type":"array","items":{"type":"string"}},"monthly":{"type":"number"}},"required":["category","label","group","total","count","transactions","monthly"]}}},"required":["monthly","byCategory"]},"outgoings":{"type":"object","properties":{"monthly":{"type":"number"},"excludes":{"type":"array","items":{"type":"string"}}},"required":["monthly","excludes"]},"signals":{"type":"array"},"recent":{"type":"object","properties":{"asAt":{"type":"string"},"days30":{"type":"object","properties":{"days":{"type":"number"},"from":{"type":"string"},"to":{"type":"string"},"complete":{"type":"boolean"},"covered":{"type":"number"},"income":{"type":"object","properties":{"total":{"type":"number"},"credits":{"type":"number"},"from":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"description":{"type":"string"},"amount":{"type":"number"}},"required":["date","description","amount"]}}},"required":["total","credits","from"]},"gambling":{"type":"object","properties":{"total":{"type":"number"},"shareOfIncome":{"type":"number"},"from":{"type":"array"}},"required":["total","shareOfIncome","from"]},"dishonours":{"type":"object","properties":{"count":{"type":"number"},"from":{"type":"array"}},"required":["count","from"]},"smallAmountCredit":{"type":"object","properties":{"lenders":{"type":"number"},"repayments":{"type":"number"},"from":{"type":"array"}},"required":["lenders","repayments","from"]},"borrowing":{"type":"object","properties":{"count":{"type":"number"},"total":{"type":"number"},"from":{"type":"array"}},"required":["count","total","from"]},"overdrawnDays":{"type":"object","properties":{"count":{},"why":{"type":"string"}},"required":["count","why"]}},"required":["days","from","to","complete","covered","income","gambling","dishonours","smallAmountCredit","borrowing","overdrawnDays"]},"days90":{"type":"object","properties":{"days":{"type":"number"},"from":{"type":"string"},"to":{"type":"string"},"complete":{"type":"boolean"},"covered":{"type":"number"},"income":{"type":"object","properties":{"total":{"type":"number"},"credits":{"type":"number"},"from":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"description":{"type":"string"},"amount":{"type":"number"}},"required":["date","description","amount"]}}},"required":["total","credits","from"]},"gambling":{"type":"object","properties":{"total":{"type":"number"},"shareOfIncome":{"type":"number"},"from":{"type":"array"}},"required":["total","shareOfIncome","from"]},"dishonours":{"type":"object","properties":{"count":{"type":"number"},"from":{"type":"array"}},"required":["count","from"]},"smallAmountCredit":{"type":"object","properties":{"lenders":{"type":"number"},"repayments":{"type":"number"},"from":{"type":"array"}},"required":["lenders","repayments","from"]},"borrowing":{"type":"object","properties":{"count":{"type":"number"},"total":{"type":"number"},"from":{"type":"array"}},"required":["count","total","from"]},"overdrawnDays":{"type":"object","properties":{"count":{},"why":{"type":"string"}},"required":["count","why"]}},"required":["days","from","to","complete","covered","income","gambling","dishonours","smallAmountCredit","borrowing","overdrawnDays"]}},"required":["asAt","days30","days90"]},"review":{"type":"array"},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"string"},"description":{"type":"string"},"amount":{"type":"number"},"category":{"type":"string"},"group":{"type":"string"},"label":{"type":"string"},"confidence":{"type":"number"},"matched":{"type":"string"},"rule":{"type":"number"},"normalised":{"type":"string"},"enrichment":{"type":"object","properties":{"category":{"type":"object","properties":{"code":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"},"known":{"type":"boolean"},"detail":{}},"required":["code","label","group","known","detail"]},"thirdParty":{"type":"object","properties":{"name":{"type":["string","null"]},"known":{"type":"boolean"},"basis":{"type":"string"},"identity":{"type":["object","null"],"properties":{"known":{"type":"boolean"},"name":{"type":"string"},"source":{"type":"string"},"fetched":{"type":"string"},"why":{"type":"string"},"abn":{"type":"string"},"acn":{},"industries":{"type":"array","items":{"type":"string"}},"logo":{"type":"string"},"api":{"type":"string"},"updated":{"type":"string"}},"required":["known","name","source","fetched"]},"merchant":{"type":["object","null"],"properties":{"name":{"type":"string"},"key":{"type":"string"},"declared":{"type":"boolean"}},"required":["name","key","declared"]}},"required":["name","known","basis","identity","merchant"]},"confidence":{"type":"object","properties":{"value":{"type":"number"},"band":{"type":"string"},"why":{"type":"string"}},"required":["value","band","why"]},"setting":{"type":"string"},"evidence":{"type":"object","properties":{"description":{"type":"string"},"normalised":{"type":"string"},"matched":{"type":"string"},"direction":{"type":"string"},"rule":{"type":"object","properties":{"index":{"type":"number"},"category":{"type":"string"},"direction":{"type":["string","null"]},"list":{"type":"string"},"line":{}},"required":["index","category","direction","list","line"]}},"required":["description","normalised","matched","direction","rule"]}},"required":["category","thirdParty","confidence","setting","evidence"]}},"required":["id","date","description","amount","category","group","label","confidence","matched","rule","normalised","enrichment"]}}},"required":["version","period","quality","income","reconciliation","commitments","expenses","outgoings","signals","recent","review","transactions"]},"asked":{"type":"boolean"},"proposal":{},"options":{},"service":{},"capacity":{},"gaps":{"type":"array"},"problems":{"type":"array"}},"required":["version","source","sample","reference","format","parse","warnings","setting","reading","asked","proposal","options","service","capacity","gaps","problems"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/statement/sample.csv":{"get":{"operationId":"getStatementSampleCsv","tags":["Statement"],"summary":"That invented statement as a bank’s CSV export, to send back to POST /v1/statement","description":"That invented statement as a bank’s CSV export, to send back to POST /v1/statement.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/statement#get-v1-statement-sample-csv"},"parameters":[{"name":"example","in":"query","required":false,"description":"which invented statement: ordinary, strained","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"text/csv":{"schema":{"type":"string"}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/capacity":{"get":{"operationId":"getCapacity","tags":["Capacity"],"summary":"The same on the invented ordinary statement, for any loan in the query","description":"The same on the invented ordinary statement, for any loan in the query.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/capacity#get-v1-capacity"},"parameters":[{"name":"loan","in":"query","required":false,"description":"the amount applied for, dollars","schema":{"type":"string"}},{"name":"rate","in":"query","required":false,"description":"the annual rate, per cent","schema":{"type":"string"}},{"name":"years","in":"query","required":false,"description":"the term, years","schema":{"type":"string"}},{"name":"benchmark","in":"query","required":false,"description":"the lender’s own monthly expense benchmark, dollars","schema":{"type":"string"}},{"name":"declared","in":"query","required":false,"description":"monthly expenses the applicant declared, dollars","schema":{"type":"string"}},{"name":"minimum","in":"query","required":false,"description":"the lender’s surplus floor, dollars a month","schema":{"type":"string"}},{"name":"gross","in":"query","required":false,"description":"gross annual income, dollars","schema":{"type":"string"}},{"name":"debts","in":"query","required":false,"description":"other debts the lender counts, dollars","schema":{"type":"string"}},{"name":"cards","in":"query","required":false,"description":"credit card limits, dollars","schema":{"type":"string"}},{"name":"retiring","in":"query","required":false,"description":"commitments that end before the loan starts, by description","schema":{"type":"string"}},{"name":"setting","in":"query","required":false,"description":"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%. Any case; every answer says which it was read under","schema":{"type":"string","enum":["strict","balanced","broad"]}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":["object","string"],"properties":{"version":{"type":"string"},"assessmentRate":{"type":"number"},"assessedIncome":{"type":"number"},"livingExpenses":{"type":"number"},"commitments":{"type":"number"},"proposedRepayment":{"type":"number"},"monthlySurplus":{"type":"number"},"netSurplusRatio":{"type":"number"},"debtServiceRatio":{"type":"number"},"dti":{"type":"object","properties":{"version":{"type":"string"},"totalDebt":{"type":"number"},"grossAnnualIncome":{"type":"number"},"ratio":{"type":"number"},"threshold":{"type":"number"},"atOrAbove":{"type":"boolean"},"headroom":{"type":"number"},"incomeAtThreshold":{"type":"number"},"unpriced":{"type":"array"},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","properties":{"principal":{"type":"number"},"monthly":{"type":"number"},"category":{"type":"string"},"transactions":{"type":"array","items":{"type":"string"}},"grossAnnualIncome":{"type":"number"},"grossMonthly":{"type":"number"},"netMonthlyOnTheStatement":{"type":"number"}}}},"required":["step","what","amount","rule","inputs"]}},"gaps":{"type":"array"},"position":{"type":"string"},"said":{"type":"string"},"apra":{"type":"object","properties":{"threshold":{"type":"number"},"share":{"type":"number"},"since":{"type":"string"},"basis":{"type":"string"}},"required":["threshold","share","since","basis"]},"complete":{"type":"boolean"}},"required":["version","totalDebt","grossAnnualIncome","ratio","threshold","atOrAbove","headroom","incomeAtThreshold","unpriced","lines","gaps","position","said","apra","complete"]},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","additionalProperties":{"type":["array","string","number","boolean"],"items":{"type":"string"}}}},"required":["step","what","amount","rule","inputs"]}},"gaps":{"type":"array","items":{"type":"string"}},"complete":{"type":"boolean"}},"required":["version","assessmentRate","assessedIncome","livingExpenses","commitments","proposedRepayment","monthlySurplus","netSurplusRatio","debtServiceRatio","dti","lines","gaps","complete"]},"version":{"type":"string"},"stores":{"type":"string"},"endpoints":{"type":"object","additionalProperties":{"type":"object","properties":{"what":{"type":"string"},"body":{"type":"string"},"query":{"type":"object","properties":{"loan":{"type":"string"},"rate":{"type":"string"},"years":{"type":"string"},"benchmark":{"type":"string"},"declared":{"type":"string"},"minimum":{"type":"string"},"gross":{"type":"string"},"debts":{"type":"string"},"cards":{"type":"string"},"retiring":{"type":"string"},"setting":{"type":"object","properties":{"what":{"type":"string"},"takes":{"type":"array","items":{"type":"string"}}},"required":["what","takes"]}},"required":["loan","rate","years","benchmark","declared","minimum","gross","debts","cards","retiring","setting"]}},"required":["what","query"]}},"proposal":{"type":"object","properties":{"principal":{"type":"number"},"rate":{"type":"number"},"years":{"type":"number"},"type":{"type":"string"},"name":{}},"required":["principal","rate","years","type","name"]},"capacity":{"type":"object","properties":{"principal":{"type":"number"},"repayment":{"type":"number"},"surplus":{"type":"number"},"assessment":{"type":"object","properties":{"version":{"type":"string"},"assessmentRate":{"type":"number"},"assessedIncome":{"type":"number"},"livingExpenses":{"type":"number"},"commitments":{"type":"number"},"proposedRepayment":{"type":"number"},"monthlySurplus":{"type":"number"},"netSurplusRatio":{"type":"number"},"debtServiceRatio":{"type":"number"},"dti":{"type":"object","properties":{"version":{"type":"string"},"totalDebt":{"type":"number"},"grossAnnualIncome":{"type":"number"},"ratio":{"type":"number"},"threshold":{"type":"number"},"atOrAbove":{"type":"boolean"},"headroom":{"type":"number"},"incomeAtThreshold":{"type":"number"},"unpriced":{"type":"array"},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","properties":{"principal":{"type":"number"},"monthly":{"type":"number"},"category":{"type":"string"},"transactions":{"type":"array","items":{"type":"string"}},"grossAnnualIncome":{"type":"number"},"grossMonthly":{"type":"number"},"netMonthlyOnTheStatement":{"type":"number"}}}},"required":["step","what","amount","rule","inputs"]}},"gaps":{"type":"array"},"position":{"type":"string"},"said":{"type":"string"},"apra":{"type":"object","properties":{"threshold":{"type":"number"},"share":{"type":"number"},"since":{"type":"string"},"basis":{"type":"string"}},"required":["threshold","share","since","basis"]},"complete":{"type":"boolean"}},"required":["version","totalDebt","grossAnnualIncome","ratio","threshold","atOrAbove","headroom","incomeAtThreshold","unpriced","lines","gaps","position","said","apra","complete"]},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","additionalProperties":{"type":["array","string","number","boolean"],"items":{"type":"string"}}}},"required":["step","what","amount","rule","inputs"]}},"gaps":{"type":"array","items":{"type":"string"}},"complete":{"type":"boolean"}},"required":["version","assessmentRate","assessedIncome","livingExpenses","commitments","proposedRepayment","monthlySurplus","netSurplusRatio","debtServiceRatio","dti","lines","gaps","complete"]},"iterations":{"type":"number"},"serviceability":{"type":"object","properties":{"principal":{"type":"number"},"repayment":{"type":"number"},"minimumSurplus":{"type":"number"}},"required":["principal","repayment","minimumSurplus"]},"dti":{"type":"object","properties":{"principal":{"type":"number"},"otherDebt":{"type":"number"},"grossAnnualIncome":{"type":"number"},"threshold":{"type":"number"},"ratioAtThatPrincipal":{"type":"number"},"unpriced":{"type":"array"}},"required":["principal","otherDebt","grossAnnualIncome","threshold","ratioAtThatPrincipal","unpriced"]},"dtiMeasured":{"type":"boolean"},"binds":{"type":"string"}},"required":["principal","repayment","surplus","assessment","iterations","serviceability","dti","dtiMeasured","binds"]},"gaps":{"type":"array","items":{"type":"string"}},"problems":{"type":"array"},"sample":{"type":"object","properties":{"key":{"type":"string"},"title":{"type":"string"},"what":{"type":"string"}},"required":["key","title","what"]},"setting":{"type":"object","properties":{"name":{"type":"string"},"target":{"type":"number"},"floor":{"type":"number"},"modelled":{"type":"boolean"},"says":{"type":"string"}},"required":["name","target","floor","modelled","says"]}},"required":["service"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]},"post":{"operationId":"postCapacity","tags":["Capacity"],"summary":"Serviceability and borrowing power for a loan, on a statement sent in the body","description":"Serviceability and borrowing power for a loan, on a statement sent in the body.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/capacity#post-v1-capacity"},"parameters":[{"name":"loan","in":"query","required":false,"description":"the amount applied for, dollars","schema":{"type":"string"}},{"name":"rate","in":"query","required":false,"description":"the annual rate, per cent","schema":{"type":"string"}},{"name":"years","in":"query","required":false,"description":"the term, years","schema":{"type":"string"}},{"name":"benchmark","in":"query","required":false,"description":"the lender’s own monthly expense benchmark, dollars","schema":{"type":"string"}},{"name":"declared","in":"query","required":false,"description":"monthly expenses the applicant declared, dollars","schema":{"type":"string"}},{"name":"minimum","in":"query","required":false,"description":"the lender’s surplus floor, dollars a month","schema":{"type":"string"}},{"name":"gross","in":"query","required":false,"description":"gross annual income, dollars","schema":{"type":"string"}},{"name":"debts","in":"query","required":false,"description":"other debts the lender counts, dollars","schema":{"type":"string"}},{"name":"cards","in":"query","required":false,"description":"credit card limits, dollars","schema":{"type":"string"}},{"name":"retiring","in":"query","required":false,"description":"commitments that end before the loan starts, by description","schema":{"type":"string"}},{"name":"setting","in":"query","required":false,"description":"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%. Any case; every answer says which it was read under","schema":{"type":"string","enum":["strict","balanced","broad"]}},{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"the CSV export as text/csv with the loan in the query, or JSON {statement, loan, rate, years, setting?, …}","content":{"application/json":{"schema":{"type":"object","description":"the CSV export as text/csv with the loan in the query, or JSON {statement, loan, rate, years, setting?, …}"}},"text/csv":{"schema":{"type":"string","description":"The bank’s CSV export, as it was downloaded."}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"proposal":{"type":"object","properties":{"principal":{"type":"number"},"rate":{"type":"number"},"years":{"type":"number"},"type":{"type":"string"},"name":{}},"required":["principal","rate","years","type","name"]},"service":{"type":"object","properties":{"version":{"type":"string"},"assessmentRate":{"type":"number"},"assessedIncome":{"type":"number"},"livingExpenses":{"type":"number"},"commitments":{"type":"number"},"proposedRepayment":{"type":"number"},"monthlySurplus":{"type":"number"},"netSurplusRatio":{"type":"number"},"debtServiceRatio":{"type":"number"},"dti":{"type":"object","properties":{"version":{"type":"string"},"totalDebt":{"type":"number"},"grossAnnualIncome":{},"ratio":{},"threshold":{"type":"number"},"atOrAbove":{},"headroom":{},"incomeAtThreshold":{"type":"number"},"unpriced":{"type":"array"},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","properties":{"principal":{"type":"number"},"monthly":{"type":"number"},"category":{"type":"string"},"transactions":{"type":"array","items":{"type":"string"}}}}},"required":["step","what","amount","rule","inputs"]}},"gaps":{"type":"array","items":{"type":"string"}},"position":{"type":"string"},"said":{"type":"string"},"apra":{"type":"object","properties":{"threshold":{"type":"number"},"share":{"type":"number"},"since":{"type":"string"},"basis":{"type":"string"}},"required":["threshold","share","since","basis"]},"complete":{"type":"boolean"}},"required":["version","totalDebt","grossAnnualIncome","ratio","threshold","atOrAbove","headroom","incomeAtThreshold","unpriced","lines","gaps","position","said","apra","complete"]},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","additionalProperties":{"type":["array","string","number","boolean"],"items":{"type":"string"}}}},"required":["step","what","amount","rule","inputs"]}},"gaps":{"type":"array","items":{"type":"string"}},"complete":{"type":"boolean"}},"required":["version","assessmentRate","assessedIncome","livingExpenses","commitments","proposedRepayment","monthlySurplus","netSurplusRatio","debtServiceRatio","dti","lines","gaps","complete"]},"capacity":{"type":"object","properties":{"principal":{"type":"number"},"repayment":{"type":"number"},"surplus":{"type":"number"},"assessment":{"type":"object","properties":{"version":{"type":"string"},"assessmentRate":{"type":"number"},"assessedIncome":{"type":"number"},"livingExpenses":{"type":"number"},"commitments":{"type":"number"},"proposedRepayment":{"type":"number"},"monthlySurplus":{"type":"number"},"netSurplusRatio":{"type":"number"},"debtServiceRatio":{"type":"number"},"dti":{"type":"object","properties":{"version":{"type":"string"},"totalDebt":{"type":"number"},"grossAnnualIncome":{},"ratio":{},"threshold":{"type":"number"},"atOrAbove":{},"headroom":{},"incomeAtThreshold":{"type":"number"},"unpriced":{"type":"array"},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","properties":{"principal":{"type":"number"},"monthly":{"type":"number"},"category":{"type":"string"},"transactions":{"type":"array","items":{"type":"string"}}}}},"required":["step","what","amount","rule","inputs"]}},"gaps":{"type":"array","items":{"type":"string"}},"position":{"type":"string"},"said":{"type":"string"},"apra":{"type":"object","properties":{"threshold":{"type":"number"},"share":{"type":"number"},"since":{"type":"string"},"basis":{"type":"string"}},"required":["threshold","share","since","basis"]},"complete":{"type":"boolean"}},"required":["version","totalDebt","grossAnnualIncome","ratio","threshold","atOrAbove","headroom","incomeAtThreshold","unpriced","lines","gaps","position","said","apra","complete"]},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","additionalProperties":{"type":["array","string","number","boolean"],"items":{"type":"string"}}}},"required":["step","what","amount","rule","inputs"]}},"gaps":{"type":"array","items":{"type":"string"}},"complete":{"type":"boolean"}},"required":["version","assessmentRate","assessedIncome","livingExpenses","commitments","proposedRepayment","monthlySurplus","netSurplusRatio","debtServiceRatio","dti","lines","gaps","complete"]},"iterations":{"type":"number"},"serviceability":{"type":"object","properties":{"principal":{"type":"number"},"repayment":{"type":"number"},"minimumSurplus":{"type":"number"}},"required":["principal","repayment","minimumSurplus"]},"dti":{},"dtiMeasured":{"type":"boolean"},"binds":{"type":"string"}},"required":["principal","repayment","surplus","assessment","iterations","serviceability","dti","dtiMeasured","binds"]},"gaps":{"type":"array","items":{"type":"string"}},"problems":{"type":"array"},"setting":{"type":"object","properties":{"name":{"type":"string"},"target":{"type":["number","null"]},"floor":{"type":"number"},"modelled":{"type":"boolean"},"says":{"type":"string"}},"required":["name","target","floor","modelled","says"]}},"required":["proposal","service","capacity","gaps","problems","setting"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/enrich":{"get":{"operationId":"getEnrich","tags":["Enrich"],"summary":"One transaction","description":"One transaction. A link, so an answer somebody disagrees with is a link they can paste into a bug report.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/enrich#get-v1-enrich"},"parameters":[{"name":"description","in":"query","required":false,"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","schema":{"type":"string"}},{"name":"amount","in":"query","required":false,"description":"the amount, signed: credits positive, debits negative. Optional, and some rules cannot be reached without it — a credit from a payroll bureau is wages and a payment to the same name is not","schema":{"type":"string"}},{"name":"setting","in":"query","required":false,"description":"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%. Any case; every answer says which it was read under","schema":{"type":"string","enum":["strict","balanced","broad"]}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"},"id":{},"date":{},"description":{"type":"string"},"amount":{"type":"number"},"category":{"type":"object","properties":{"code":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"},"known":{"type":"boolean"},"detail":{"anyOf":[{"$ref":"#/components/schemas/Detail"},{"type":"null"}]}},"required":["code","label","group","known","detail"]},"third_party":{"type":"object","properties":{"name":{"type":["string","null"]},"known":{"type":"boolean"},"basis":{"type":"string"}},"required":["name","known","basis"]},"confidence":{"type":"object","properties":{"value":{"type":"number"},"band":{"type":"string"},"why":{"type":"string"}},"required":["value","band","why"]},"setting":{"type":"object","properties":{"name":{"type":"string"},"target":{"type":["number","null"]},"floor":{"type":"number"},"modelled":{"type":"boolean"},"says":{"type":"string"}},"required":["name","target","floor","modelled","says"]},"evidence":{"type":"object","properties":{"normalised":{"type":"string"},"matched":{"type":["string","null"]},"direction":{"type":"string"},"rule":{"type":["object","null"],"properties":{"index":{"type":"number"},"category":{"type":"string"},"direction":{"type":["string","null"]},"list":{"type":"string"},"line":{}},"required":["index","category","direction","list","line"]}},"required":["normalised","matched","direction","rule"]},"could_not_read":{"type":"array"},"service":{"type":"string"},"engine":{"type":"string"},"what":{"type":"string"},"not_advice":{"type":"string"},"predicts_does_not_decide":{"type":"string"},"nothing_is_kept":{"type":"string"},"endpoints":{"type":"object","additionalProperties":{"type":"object","properties":{"what":{"type":"string"},"query":{"type":"object","properties":{"description":{"type":"string"},"amount":{"type":"string"},"setting":{"type":"object","properties":{"what":{"type":"string"},"takes":{"type":"array","items":{"type":"string"}}},"required":["what","takes"]}},"required":["setting"]},"body":{"type":"string"},"setting_from":{"type":"string"},"content_type":{"type":"string"},"note":{"type":"string"}},"required":["what"]}},"says_when_it_does_not_know":{"type":"object","properties":{"word":{"type":"string"},"how":{"type":"string"},"why":{"type":"string"}},"required":["word","how","why"]},"bands":{"type":"array","items":{"type":"object","properties":{"band":{"type":"string"},"confidence":{"type":"number"},"knows":{"type":"string"},"why":{"type":"string"}},"required":["band","confidence","knows","why"]}},"settings":{"type":"array","items":{"type":"object","properties":{"setting":{"type":"string"},"default":{"type":"boolean"},"target":{"type":["number","null"]},"modelled":{"type":"boolean"},"says":{"type":"string"}},"required":["setting","default","target","modelled","says"]}},"default_setting":{"type":"string"}},"required":["version"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]},"post":{"operationId":"postEnrich","tags":["Enrich"],"summary":"A list of transactions, up to 20,000 in one request, with the coverage of the whole list","description":"A list of transactions, up to 20,000 in one request, with the coverage of the whole list.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/enrich#post-v1-enrich"},"parameters":[{"name":"setting","in":"query","required":false,"description":"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%. Any case; every answer says which it was read under","schema":{"type":"string","enum":["strict","balanced","broad"]}},{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{\"transactions\": [{\"id\": \"1\", \"date\": \"2026-08-02\", \"description\": \"WOOLWORTHS 1248 RICHMOND\", \"amount\": -142.86}], \"setting\": \"balanced\"}","content":{"application/json":{"schema":{"type":"object","description":"{\"transactions\": [{\"id\": \"1\", \"date\": \"2026-08-02\", \"description\": \"WOOLWORTHS 1248 RICHMOND\", \"amount\": -142.86}], \"setting\": \"balanced\"}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"},"engine":{"type":"object","properties":{"categorise":{"type":"string"},"market":{"type":"string"},"rules":{"type":"number"},"model":{"type":"string"}},"required":["categorise","market","rules","model"]},"setting":{"type":"object","properties":{"name":{"type":"string"},"target":{"type":["number","null"]},"floor":{"type":"number"},"modelled":{"type":"boolean"},"says":{"type":"string"}},"required":["name","target","floor","modelled","says"]},"predicts_does_not_decide":{"type":"string"},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":["string","null"]},"date":{"type":["string","null"]},"description":{"type":"string"},"amount":{"type":"number"},"category":{"type":"object","properties":{"code":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"},"known":{"type":"boolean"},"detail":{"anyOf":[{"$ref":"#/components/schemas/Detail"},{"type":"null"}]}},"required":["code","label","group","known","detail"]},"third_party":{"type":"object","properties":{"name":{"type":["string","null"]},"known":{"type":"boolean"},"basis":{"type":"string"}},"required":["name","known","basis"]},"confidence":{"type":"object","properties":{"value":{"type":"number"},"band":{"type":"string"},"why":{"type":"string"}},"required":["value","band","why"]},"setting":{"type":"string"},"evidence":{"type":"object","properties":{"normalised":{"type":"string"},"matched":{"type":["string","null"]},"direction":{"type":"string"},"rule":{"type":["object","null"],"properties":{"index":{"type":"number"},"category":{"type":"string"},"direction":{"type":["string","null"]},"list":{"type":"string"},"line":{}},"required":["index","category","direction","list","line"]}},"required":["normalised","matched","direction","rule"]}},"required":["id","date","description","amount","category","third_party","confidence","setting","evidence"]}},"coverage":{"type":"object","properties":{"by_money":{"type":"object","properties":{"total":{"type":"number"},"category":{"type":"number"},"category_share":{"type":"number"},"third_party":{"type":"number"},"third_party_share":{"type":"number"}},"required":["total","category","category_share","third_party","third_party_share"]},"by_money_out":{"type":"object","properties":{"total":{"type":"number"},"excludes":{"type":"array","items":{"type":"string"}},"category":{"type":"number"},"category_share":{"type":["number","null"]},"third_party":{"type":"number"},"third_party_share":{"type":["number","null"]}},"required":["total","excludes","category","category_share","third_party","third_party_share"]},"by_row":{"type":"object","properties":{"total":{"type":"number"},"category":{"type":"number"},"category_share":{"type":"number"},"third_party":{"type":"number"},"third_party_share":{"type":"number"},"unknown":{"type":"number"}},"required":["total","category","category_share","third_party","third_party_share","unknown"]},"by_band":{"type":"array","items":{"type":"object","properties":{"band":{"type":"string"},"rows":{"type":"number"},"share":{"type":"number"},"money":{"type":"number"},"confidence":{"type":"number"},"why":{"type":"string"}},"required":["band","rows","share","money","confidence","why"]}},"by_category":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"},"rows":{"type":"number"},"money":{"type":"number"},"third_party_named":{"type":"number"}},"required":["category","label","group","rows","money","third_party_named"]}}},"required":["by_money","by_money_out","by_row","by_band","by_category"]},"unknown":{"type":"array","items":{"type":"object","properties":{"payee":{"type":"string"},"example":{"type":"string"},"count":{"type":"number"},"total":{"type":"number"},"direction":{"type":"string"},"declined":{"type":"boolean"},"matched":{}},"required":["payee","example","count","total","direction","declined","matched"]}}},"required":["version","engine","setting","predicts_does_not_decide","transactions","coverage","unknown"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/enrich/rules":{"get":{"operationId":"getEnrichRules","tags":["Enrich"],"summary":"What the engine is made of","description":"What the engine is made of: the categories it can assign and how many rules it holds.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/enrich#get-v1-enrich-rules"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"},"engine":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}},"required":["code","label","group"]}},"unknown_is":{"type":"object","properties":{"code":{"type":"string"},"word":{"type":"string"},"is_not_a_category":{"type":"boolean"}},"required":["code","word","is_not_a_category"]},"rules":{"type":"number"},"rules_from":{"type":"string"}},"required":["version","engine","categories","unknown_is","rules","rules_from"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/enrich/accuracy":{"get":{"operationId":"getEnrichAccuracy","tags":["Enrich"],"summary":"What it gets right, measured against payee lists nobody here chose, per category and per confidence…","description":"What it gets right, measured against payee lists nobody here chose, per category and per confidence band.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/enrich#get-v1-enrich-accuracy"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"},"measured_on":{"type":"string"},"corpora":{"type":"array","items":{"type":"string"}},"coverage_is_not_accuracy":{"type":"string"},"by_band":{"type":"array","items":{"type":"object","properties":{"band":{"type":"string"},"names":{"type":"number"},"claimed_a_category":{"type":"number"},"right":{"type":"number"},"accuracy":{"type":"number"},"why":{"type":"string"}},"required":["band","names","claimed_a_category","right","accuracy","why"]}},"precision_floor":{"type":"number"},"precision_floor_is_per_category":{"type":"string"},"floor_from":{"type":"number"},"by_category":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"label":{"type":"string"},"names":{"type":"number"},"categorised":{"type":"number"},"coverage":{"type":["number","null"]},"right_of_those":{"type":"number"},"answers":{"type":"number"},"answers_right":{"type":"number"},"precision":{"type":"number"},"clears_precision_floor":{"type":["boolean","null"]},"too_few_to_judge":{"type":"boolean"},"third_party_named":{"type":"number"}},"required":["category","label","names","categorised","coverage","right_of_those","answers","answers_right","precision","clears_precision_floor","too_few_to_judge","third_party_named"]}},"must_not_answer":{"type":"object","properties":{"names":{"type":"number"},"answeredAnyway":{"type":"number"},"declined":{"type":"number"}},"required":["names","answeredAnyway","declined"]},"long_tail":{"type":"object","properties":{"names":{"type":"number"},"named":{"type":"number"},"kind":{"type":"number"},"modelled":{"type":"number"},"unknown":{"type":"number"}},"required":["names","named","kind","modelled","unknown"]},"not_measured":{"type":"array","items":{"type":"string"}},"not_measured_why":{"type":"object","properties":{"strata":{"type":"string"},"government":{"type":"string"},"person":{"type":"string"},"income_salary":{"type":"string"},"income_other":{"type":"string"},"bnpl":{"type":"string"},"transfer":{"type":"string"},"fees":{"type":"string"},"child_support":{"type":"string"},"loan_proceeds":{"type":"string"}},"required":["strata","government","person","income_salary","income_other","bnpl","transfer","fees","child_support","loan_proceeds"]},"silence_is_not_a_pass":{"type":"string"},"re_run_it":{"type":"string"}},"required":["version","measured_on","corpora","coverage_is_not_accuracy","by_band","precision_floor","precision_floor_is_per_category","floor_from","by_category","must_not_answer","long_tail","not_measured","not_measured_why","silence_is_not_a_pass","re_run_it"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1":{"get":{"operationId":"getIndex","tags":["Index"],"summary":"Describes this API","description":"Describes this API: what it takes and what it returns.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference#get-v1"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"not_advice":{"type":"string"},"endpoints":{"type":"object","additionalProperties":{"type":"object","properties":{"what":{"type":"string"},"query":{"type":"object","properties":{"amount":{"type":"string"},"value":{"type":"string"},"years":{"type":"string"},"purpose":{"type":"string"},"repayment":{"type":"string"},"io":{"type":"string"}},"required":["amount","value","years","purpose","repayment","io"]}},"required":["what"]}},"figures":{"type":"object","properties":{"source":{"type":"string"},"retrieved_at":{"type":"string"},"brands":{"type":"array","items":{"type":"string"}},"products":{"type":"number"}},"required":["source","retrieved_at","brands","products"]},"docs":{"type":"string"},"openapi":{"type":"string"},"errors":{"type":"string"},"every_endpoint":{"type":"object","additionalProperties":{"type":"string"}}},"required":["service","version","not_advice","endpoints","figures","docs","openapi","errors","every_endpoint"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/compare":{"get":{"operationId":"getCompare","tags":["Compare"],"summary":"Rank the products in the dataset for one loan","description":"Rank the products in the dataset for one loan.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/compare#get-v1-compare"},"parameters":[{"name":"amount","in":"query","required":false,"description":"dollars borrowed, default 500000","schema":{"type":"string"}},{"name":"value","in":"query","required":false,"description":"what the property is worth, default 625000 — the two together are the loan to value ratio, which is what decides the rate","schema":{"type":"string"}},{"name":"years","in":"query","required":false,"description":"the term, default 30","schema":{"type":"string"}},{"name":"purpose","in":"query","required":false,"description":"OWNER_OCCUPIED or INVESTMENT","schema":{"type":"string"}},{"name":"repayment","in":"query","required":false,"description":"PRINCIPAL_AND_INTEREST or INTEREST_ONLY","schema":{"type":"string"}},{"name":"io","in":"query","required":false,"description":"years of interest-only repayments, used only with repayment=INTEREST_ONLY","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"},"not_advice":{"type":"string"},"query":{"type":"object","properties":{"amount":{"type":"number"},"value":{"type":"number"},"years":{"type":"number"},"purpose":{"type":"string"},"repayment":{"type":"string"},"interestOnlyYears":{"type":"number"},"lvr":{"type":"number"},"deposit":{"type":"number"},"showAll":{"type":"boolean"}},"required":["amount","value","years","purpose","repayment","interestOnlyYears","lvr","deposit","showAll"]},"as_at":{"type":"string"},"figures":{"type":"object","properties":{"source":{"type":"string"},"standards":{"type":"string"},"retrieved_at":{"type":"string"},"age_days":{"type":"number"},"brands":{"type":"array","items":{"type":"string"}},"brands_on_the_register":{"type":"number"},"products_read":{"type":"number"}},"required":["source","standards","retrieved_at","age_days","brands","brands_on_the_register","products_read"]},"ordered_by":{"type":"string"},"ranked":{"type":"array","items":{"type":"object","properties":{"rank":{"type":"number"},"lender":{"type":"string"},"product":{"type":"string"},"product_id":{"type":"string"},"rate":{"type":"number"},"rate_type":{"type":"string"},"fixed_years":{},"comparison_rate_published_by_lender":{"type":["number","null"]},"lvr_band_applied":{"type":["object","null"],"properties":{"from":{"type":"number"},"to":{"type":["number","null"]}},"required":["from","to"]},"rate_turns_on_lvr":{"type":"boolean"},"rates_not_available_at_this_lvr":{"type":"array","items":{"type":"object","properties":{"rate":{"type":"number"},"lendingRateType":{"type":"string"},"why":{"type":"string"}},"required":["rate","lendingRateType","why"]}},"monthly_repayment":{"type":"number"},"fees":{"type":"object","properties":{"upfront":{"type":"number"},"annual":{"type":"number"},"monthly":{"type":"number"},"discharge_if_exiting":{"type":"number"},"could_not_be_priced":{"type":"array","items":{"type":"string"}},"charged_only_if_something_happens":{"type":"array","items":{"type":"string"}}},"required":["upfront","annual","monthly","discharge_if_exiting","could_not_be_priced","charged_only_if_something_happens"]},"cost_over_window":{"type":"number"},"window_years":{"type":"number"},"cost_is_a_floor":{"type":"boolean"},"published_data_problems":{"type":"array","items":{"type":"string"}},"retrieved_at":{"type":"string"},"source":{"type":"string"}},"required":["rank","lender","product","product_id","rate","rate_type","fixed_years","comparison_rate_published_by_lender","lvr_band_applied","rate_turns_on_lvr","rates_not_available_at_this_lvr","monthly_repayment","fees","cost_over_window","window_years","cost_is_a_floor","published_data_problems","retrieved_at","source"]}},"fixed_not_ranked":{"type":"array","items":{"type":"object","properties":{"rank":{},"lender":{"type":"string"},"product":{"type":"string"},"product_id":{"type":"string"},"rate":{"type":"number"},"rate_type":{"type":"string"},"fixed_years":{"type":"number"},"comparison_rate_published_by_lender":{"type":"number"},"lvr_band_applied":{"type":["object","null"],"properties":{"from":{"type":"number"},"to":{"type":["number","null"]}},"required":["from","to"]},"rate_turns_on_lvr":{"type":"boolean"},"rates_not_available_at_this_lvr":{"type":"array","items":{"type":"object","properties":{"rate":{"type":"number"},"lendingRateType":{"type":"string"},"why":{"type":"string"}},"required":["rate","lendingRateType","why"]}},"monthly_repayment":{"type":"number"},"fees":{"type":"object","properties":{"upfront":{"type":"number"},"annual":{"type":"number"},"monthly":{"type":"number"},"discharge_if_exiting":{"type":"number"},"could_not_be_priced":{"type":"array","items":{"type":"string"}},"charged_only_if_something_happens":{"type":"array","items":{"type":"string"}}},"required":["upfront","annual","monthly","discharge_if_exiting","could_not_be_priced","charged_only_if_something_happens"]},"cost_over_window":{"type":"number"},"window_years":{"type":"number"},"cost_is_a_floor":{"type":"boolean"},"published_data_problems":{"type":"array","items":{"type":"string"}},"retrieved_at":{"type":"string"},"source":{"type":"string"}},"required":["rank","lender","product","product_id","rate","rate_type","fixed_years","comparison_rate_published_by_lender","lvr_band_applied","rate_turns_on_lvr","rates_not_available_at_this_lvr","monthly_repayment","fees","cost_over_window","window_years","cost_is_a_floor","published_data_problems","retrieved_at","source"]}},"not_compared":{"type":"array","items":{"type":"object","properties":{"lender":{"type":"string"},"product":{"type":"string"},"product_id":{"type":"string"},"why":{"type":"string"}},"required":["lender","product","product_id","why"]}},"counts":{"type":"object","properties":{"considered":{"type":"number"},"ranked":{"type":"number"},"fixedNotRanked":{"type":"number"},"excluded":{"type":"number"},"costIsAFloor":{"type":"number"},"tieredOnLvr":{"type":"number"},"lenders":{"type":"number"}},"required":["considered","ranked","fixedNotRanked","excluded","costIsAFloor","tieredOnLvr","lenders"]},"notes":{"type":"array","items":{"type":"string"}},"could_not_read":{"type":"array"}},"required":["version","not_advice","query","as_at","figures","ordered_by","ranked","fixed_not_ranked","not_compared","counts","notes","could_not_read"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/dataset":{"get":{"operationId":"getDataset","tags":["Compare"],"summary":"What was read, from whom, and when","description":"What was read, from whom, and when.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/compare#get-v1-dataset"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"retrievedAt":{"type":"string"},"standards":{"type":"string"},"brands":{"type":"array","items":{"type":"string"}},"brandCount":{"type":"number"},"registerBrandNames":{"type":"array","items":{"type":"string"}},"productCount":{"type":"number"},"costableCount":{"type":"number"},"withProblems":{"type":"number"},"category":{"type":"string"},"registerBrands":{"type":"number"},"registerCountedOn":{"type":"string"},"brands_not_read":{"type":"number"},"what_is_not_here":{"type":"array","items":{"type":"string"}}},"required":["retrievedAt","standards","brands","brandCount","registerBrandNames","productCount","costableCount","withProblems","category","registerBrands","registerCountedOn","brands_not_read","what_is_not_here"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/hardship-clock":{"get":{"operationId":"getHardshipClock","tags":["Collections"],"summary":"Put a hardship matter on the statutory clock","description":"Put a hardship matter on the statutory clock. Any of the query fields below; `notice` is the one without which there is no clock.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/collections#get-v1-hardship-clock"},"parameters":[{"name":"ref","in":"query","required":false,"description":"File reference","schema":{"type":"string"}},{"name":"contract","in":"query","required":false,"description":"The contract is a","schema":{"type":"string","enum":["credit_contract","consumer_lease"]}},{"name":"notice","in":"query","required":false,"description":"Hardship notice received","schema":{"type":"string"}},{"name":"noticeTo","in":"query","required":false,"description":"…or by this day, if only the week is known","schema":{"type":"string"}},{"name":"channel","in":"query","required":false,"description":"The notice arrived","schema":{"type":"string","enum":["phone","in_person","online_form","email","letter","sms","other"]}},{"name":"represented","in":"query","required":false,"description":"Acting for the borrower","schema":{"type":"string","enum":["financial_counsellor","other_representative","none"]}},{"name":"reason","in":"query","required":false,"description":"The borrower said the hardship was","schema":{"type":"string","enum":["overcommitment","reduced_income","unemployment","medical","separation","bereavement","business_downturn","parental_leave","abuse","natural_disaster","other"]}},{"name":"identified","in":"query","required":false,"description":"Recognised as a hardship notice on","schema":{"type":"string"}},{"name":"requested","in":"query","required":false,"description":"Information asked for on","schema":{"type":"string"}},{"name":"stated","in":"query","required":false,"description":"…the date stated in that notice","schema":{"type":"string"}},{"name":"received","in":"query","required":false,"description":"Information received on","schema":{"type":"string"}},{"name":"decided","in":"query","required":false,"description":"Decision notice given on","schema":{"type":"string"}},{"name":"outcome","in":"query","required":false,"description":"…and it said","schema":{"type":"string","enum":["agreed","not_agreed"]}},{"name":"declineReason","in":"query","required":false,"description":"…and the reason recorded for not agreeing","schema":{"type":"string"}},{"name":"agreed","in":"query","required":false,"description":"Agreement reached on","schema":{"type":"string"}},{"name":"deferral","in":"query","required":false,"description":"…deferring obligations for, in days","schema":{"type":"string"}},{"name":"assistance","in":"query","required":false,"description":"…and the assistance given was","schema":{"type":"string","enum":["deferral","payment_arrangement","interest_only","term_extension","capitalisation_of_arrears","arrears_payment_arrangement","serviceability_period","interest_rate_reduction","supported_sale","other"]}},{"name":"changed","in":"query","required":false,"description":"Particulars of the change given on","schema":{"type":"string"}},{"name":"withdrawn","in":"query","required":false,"description":"Notice withdrawn on","schema":{"type":"string"}},{"name":"complaint","in":"query","required":false,"description":"Complaint received on","schema":{"type":"string"}},{"name":"answered","in":"query","required":false,"description":"…answered in writing on","schema":{"type":"string"}},{"name":"defaulted","in":"query","required":false,"description":"Default notice given on","schema":{"type":"string"}},{"name":"remedyBy","in":"query","required":false,"description":"…the day it states for remedying the default","schema":{"type":"string"}},{"name":"postponed","in":"query","required":false,"description":"Postponement request received on","schema":{"type":"string"}},{"name":"postponedAnswered","in":"query","required":false,"description":"…answered in writing on","schema":{"type":"string"}},{"name":"earlier","in":"query","required":false,"description":"Earlier hardship notices","schema":{"type":"string"}},{"name":"amend","in":"query","required":false,"description":"Amendments to a due date","schema":{"type":"string"}},{"name":"balance","in":"query","required":false,"description":"Balance owing","schema":{"type":"string"}},{"name":"rate","in":"query","required":false,"description":"Contract rate","schema":{"type":"string"}},{"name":"repayment","in":"query","required":false,"description":"Contractual repayment","schema":{"type":"string"}},{"name":"plan","in":"query","required":false,"description":"The arrangement is a","schema":{"type":"string","enum":["deferral","reduced_payment"]}},{"name":"months","in":"query","required":false,"description":"For","schema":{"type":"string"}},{"name":"pay","in":"query","required":false,"description":"…paying, each month","schema":{"type":"string"}},{"name":"asAt","in":"query","required":false,"description":"Read the clock as at","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"},"not_a_decision":{"type":"string"},"compilation":{"type":"string"},"as_at":{"type":"string"},"as_at_supplied":{"type":"boolean"},"today_is_taken_in":{"type":"string"},"stores":{"type":"string"},"could_not_be_read":{"type":"array"},"account":{"type":["string","null"]},"contract":{"type":"string"},"notice":{"type":"object","properties":{"on":{"type":"string"},"channel":{"type":["string","null"]},"channelLabel":{"type":["string","null"]},"channelKnown":{"type":"boolean"},"uncertain":{"type":"boolean"},"source":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]}},"required":["on","channel","channelLabel","channelKnown","uncertain","source"]},"statement":{"type":"string"},"the_six_asic_could_not_get":{"type":"object","properties":{"recorded":{"type":"number"},"of":{"type":"number"},"not_recorded":{"type":"array","items":{"type":"string"}},"says":{"type":"string"},"source":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"what":{"type":"string"},"asic":{"type":"string"},"para":{"type":"string"},"recorded":{"type":"boolean"},"state":{"type":"string"},"value":{"type":["object","array","string","null"],"properties":{"requested":{"type":"string"},"stated":{"type":"string"},"received":{"type":["string","null"]}},"required":["requested","stated","received"],"items":{"type":"string"}},"says":{"type":"string"},"provision":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"text_as_recorded":{"type":"string"}},"required":["id","what","asic","para"]}},"not_a_finding":{"type":"string"},"what":{"type":"string"}},"required":["source","fields"]},"notice_ledger":{"type":"object","properties":{"as_at":{"type":"string"},"says":{"type":"string"},"recorded":{"type":"number"},"of_the_required":{"type":"number"},"not_produced":{"type":"array","items":{"type":"string"}},"cannot_be_told":{"type":"array"},"not_a_finding":{"type":"string"},"notices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"notice":{"type":"string"},"state":{"type":"string"},"state_words":{"type":"string"},"required_when":{"type":"string"},"is_a_permission_not_a_duty":{"type":"boolean"},"produced_on":{"type":["string","null"]},"period":{"type":["object","null"],"properties":{"from":{"type":"string"},"fromEvent":{"type":"string"},"days":{"type":"number"},"due":{"type":"string"},"rule":{"type":["string","null"]}},"required":["from","fromEvent","days","due","rule"]},"days_run":{"type":["object","null"],"properties":{"from":{"type":"string"},"due":{"type":"string"},"allowed":{"type":"number"},"asAt":{"type":"string"},"run":{"type":"number"},"countedTo":{"type":"string"},"producedOn":{"type":["string","null"]},"past":{"type":["number","null"]},"left":{"type":["number","null"]},"says":{"type":"string"}},"required":["from","due","allowed","asAt","run","countedTo","producedOn","past","left","says"]},"says":{"type":"string"},"provision":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"period_provision":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]}},"required":["id","notice","state","state_words","required_when","is_a_permission_not_a_duty","produced_on","period","days_run","says","provision"]}},"due_dates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"what":{"type":"string"},"whose":{"type":"string"},"amendable":{"type":"boolean"},"as_first_set":{"type":"string"},"now":{"type":"string"},"changed":{"type":"boolean"},"changes_recorded":{"type":"number"},"may_move":{"type":"string"},"because":{"type":"string"},"does_not_move":{"type":"object","properties":{"what":{"type":"string"},"why":{"type":"string"}},"required":["what","why"]}},"required":["id","what","whose","amendable","as_first_set","now","changed","changes_recorded"]}},"amendment_trail":{"type":"array","items":{"type":"object","properties":{"n":{"type":"number"},"target":{"type":"string"},"to":{"type":"string"},"on":{"type":"string"},"reason":{"type":"string"},"by":{},"what":{"type":"string"},"from":{"type":"string"},"applied":{"type":"boolean"},"says":{"type":"string"},"source":{}},"required":["n","target","to","on","reason","by","what","from","applied","says","source"]}},"notes":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"says":{"type":"string"},"source":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]}},"required":["code","says","source"]}}},"required":["as_at","says","recorded","of_the_required","not_produced","cannot_be_told","not_a_finding","notices","due_dates","amendment_trail","notes"]},"seal":{"type":"object","properties":{"id":{"type":"string"},"algorithm":{"type":"string"},"sealed_at":{"type":"string"},"verification":{"type":"object","properties":{"valid":{"type":"boolean"},"expected":{"type":"string"},"actual":{"type":"string"}},"required":["valid","expected","actual"]},"proves":{"type":"string"},"nothing_is_kept":{"type":"string"},"tampered":{"type":"object","properties":{"what_was_changed":{"type":"string"},"why_that_one":{"type":"string"},"before":{"type":"string"},"after":{"type":"string"},"verification":{"type":"object","properties":{"valid":{"type":"boolean"},"expected":{"type":"string"},"actual":{"type":"string"},"reason":{"type":"string"}},"required":["valid","expected","actual","reason"]},"detected":{"type":"boolean"}},"required":["what_was_changed","why_that_one","before","after","verification","detected"]},"other_changes_offered":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"why":{"type":"string"}},"required":["id","label","why"]}}},"required":["id","algorithm","sealed_at","verification","proves","nothing_is_kept","tampered","other_changes_offered"]},"past_the_deadline":{"type":"array","items":{"type":"string"}},"next":{},"obligations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"what":{"type":"string"},"owed_by":{"type":"string"},"is_a_permission_not_a_duty":{"type":"boolean"},"status":{"type":"string"},"status_words":{"type":"string"},"period":{"type":"object","properties":{"from_event":{"type":"string"},"from":{"type":"string"},"days":{"type":"number"},"ends":{"type":"string"},"working":{"type":"string"}},"required":["from_event","from","days","ends","working"]},"days_past_the_end":{"type":"number"},"days_left":{},"done_on":{"type":["string","null"]},"late_by_days":{},"rule":{"type":["string","null"]},"because":{"type":"string"},"provision":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"period_provision":{"type":["object","null"],"properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]}},"required":["id","what","owed_by","is_a_permission_not_a_duty","status","status_words","period","days_past_the_end","days_left","done_on","late_by_days","rule","because","provision","period_provision"]}},"enforcement":{"type":"object","properties":{"state":{"type":"string"},"because":{"type":"string"},"clearOn":{},"source":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"reasons":{"type":"array"}},"required":["state","because","clearOn","source","reasons"]},"cautions":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string"},"code":{"type":"string"},"says":{"type":"string"},"source":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]}},"required":["from","code","says","source"]}},"periods":{"type":"object","properties":{"informationRequest":{"type":"number"},"debtorResponse":{"type":"number"},"decisionNoInfo":{"type":"number"},"decisionNoResponse":{"type":"number"},"decisionAfterInfo":{"type":"number"},"smallChangeDays":{"type":"number"},"changeNotice":{"type":"number"},"defaultRemedy":{"type":"number"},"enforcementHold":{"type":"number"},"hardshipLookbackMonths":{"type":"number"},"postponementNotice":{"type":"number"},"postponementHold":{"type":"number"},"idrResponse":{"type":"number"}},"required":["informationRequest","debtorResponse","decisionNoInfo","decisionNoResponse","decisionAfterInfo","smallChangeDays","changeNotice","defaultRemedy","enforcementHold","hardshipLookbackMonths","postponementNotice","postponementHold","idrResponse"]},"service":{"type":"string"},"what":{"type":"string"},"not_advice":{"type":"string"},"endpoints":{"type":"object","additionalProperties":{"type":"object","properties":{"what":{"type":"string"}},"required":["what"]}},"query":{"type":"object","properties":{"ref":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"contract":{"type":"object","properties":{"takes":{"type":"array","items":{"type":"string"}},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"notice":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"},"required":{"type":"boolean"}},"required":["takes","what","note","required"]},"noticeTo":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"channel":{"type":"object","properties":{"takes":{"type":"array","items":{"type":"string"}},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"represented":{"type":"object","properties":{"takes":{"type":"array","items":{"type":"string"}},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"reason":{"type":"object","properties":{"takes":{"type":"array","items":{"type":"string"}},"several":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","several","what","note"]},"identified":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"requested":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"stated":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"received":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"decided":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"outcome":{"type":"object","properties":{"takes":{"type":"array","items":{"type":"string"}},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"declineReason":{"type":"object","properties":{"takes":{"type":"string"},"at_most_characters":{"type":"number"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","at_most_characters","what","note"]},"agreed":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"deferral":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"assistance":{"type":"object","properties":{"takes":{"type":"array","items":{"type":"string"}},"several":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","several","what","note"]},"changed":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"withdrawn":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"complaint":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"answered":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"}},"required":["takes","what"]},"defaulted":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"remedyBy":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"postponed":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"postponedAnswered":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"}},"required":["takes","what"]},"earlier":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"amend":{"type":"object","properties":{"takes":{"type":"string"},"at_most_characters":{"type":"number"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","at_most_characters","what","note"]},"balance":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"rate":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"repayment":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"plan":{"type":"object","properties":{"takes":{"type":"array","items":{"type":"string"}},"what":{"type":"string"}},"required":["takes","what"]},"months":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"pay":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]},"asAt":{"type":"object","properties":{"takes":{"type":"string"},"what":{"type":"string"},"note":{"type":"string"}},"required":["takes","what","note"]}},"required":["ref","contract","notice","noticeTo","channel","represented","reason","identified","requested","stated","received","decided","outcome","declineReason","agreed","deferral","assistance","changed","withdrawn","complaint","answered","defaulted","remedyBy","postponed","postponedAnswered","earlier","amend","balance","rate","repayment","plan","months","pay","asAt"]},"the_notice_ledger":{"type":"object","properties":{"what":{"type":"string"},"why":{"type":"string"},"states":{"type":"object","properties":{"recorded":{"type":"string"},"not_produced":{"type":"string"},"not_required":{"type":"string"},"cannot_tell":{"type":"string"}},"required":["recorded","not_produced","not_required","cannot_tell"]},"notices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"notice":{"type":"string"},"required_when":{"type":"string"}},"required":["id","notice","required_when"]}},"not_a_finding":{"type":"string"}},"required":["what","why","states","notices","not_a_finding"]},"amendable_due_dates":{"type":"object","properties":{"what":{"type":"string"},"why":{"type":"string"},"write_each_as":{"type":"string"},"dates":{"type":"object","additionalProperties":{"type":"object","properties":{"what":{"type":"string"},"whose":{"type":"string"},"may_move":{"type":"string"},"because":{"type":"string"},"does_not_move":{"type":"object","properties":{"what":{"type":"string"},"why":{"type":"string"}},"required":["what","why"]}},"required":["what","whose","may_move","because","does_not_move"]}}},"required":["what","why","write_each_as","dates"]},"statuses":{"type":"object","properties":{"met":{"type":"string"},"met_late":{"type":"string"},"due":{"type":"string"},"overdue":{"type":"string"},"not_applicable":{"type":"string"},"cannot_tell":{"type":"string"}},"required":["met","met_late","due","overdue","not_applicable","cannot_tell"]},"examples":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"what":{"type":"string"},"url":{"type":"string"}},"required":["title","what","url"]}}},"required":["version","not_a_decision","today_is_taken_in","stores","the_six_asic_could_not_get"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/hardship-clock/provisions":{"get":{"operationId":"getHardshipClockProvisions","tags":["Collections"],"summary":"Every period this engine knows, with the provision it comes from, for a credit contract and for a…","description":"Every period this engine knows, with the provision it comes from, for a credit contract and for a consumer lease.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/collections#get-v1-hardship-clock-provisions"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"compilation":{"type":"string"},"periods":{"type":"object","properties":{"informationRequest":{"type":"number"},"debtorResponse":{"type":"number"},"decisionNoInfo":{"type":"number"},"decisionNoResponse":{"type":"number"},"decisionAfterInfo":{"type":"number"},"smallChangeDays":{"type":"number"},"changeNotice":{"type":"number"},"defaultRemedy":{"type":"number"},"enforcementHold":{"type":"number"},"hardshipLookbackMonths":{"type":"number"},"postponementNotice":{"type":"number"},"postponementHold":{"type":"number"},"idrResponse":{"type":"number"}},"required":["informationRequest","debtorResponse","decisionNoInfo","decisionNoResponse","decisionAfterInfo","smallChangeDays","changeNotice","defaultRemedy","enforcementHold","hardshipLookbackMonths","postponementNotice","postponementHold","idrResponse"]},"hardship_lookback_is_calendar_months":{"type":"boolean"},"credit_contract":{"type":"object","properties":{"hardship_notice":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"information_request":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"decision_notice":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"decision_period":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"small_change":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"change_notice":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"default_notice":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"default_notice_content":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"default_notice_form":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"},"table":{"type":"array","items":{"type":"object","properties":{"item":{"type":"number"},"contractEnteredOn":{"type":"string"},"noticeGivenOn":{"type":"string"},"form":{"type":"array","items":{"type":"string"}}},"required":["item","contractEnteredOn","noticeGivenOn","form"]}}},"required":["cite","quote","table"]},"enforcement_hold":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"enforcement_hold_applies":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"postponement_request":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"postponement_hold":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"idr_hardship":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"idr_urgent":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"idr_reasons":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"generic_reasons":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"follow_up":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"identify":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"dropout":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"scaling":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"effect_of_assistance":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"data_capture":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"data_capture_action":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]}},"required":["hardship_notice","information_request","decision_notice","decision_period","small_change","change_notice","default_notice","default_notice_content","default_notice_form","enforcement_hold","enforcement_hold_applies","postponement_request","postponement_hold","idr_hardship","idr_urgent","idr_reasons","generic_reasons","follow_up","identify","dropout","scaling","effect_of_assistance","data_capture","data_capture_action"]},"consumer_lease":{"type":"object","properties":{"hardship_notice":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"information_request":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"decision_notice":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"decision_period":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"small_change":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"change_notice":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"default_notice":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"default_notice_content":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"default_notice_form":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"},"table":{}},"required":["cite","quote","table"]},"enforcement_hold":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"enforcement_hold_applies":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"postponement_request":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"postponement_hold":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"idr_hardship":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"idr_urgent":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"idr_reasons":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"generic_reasons":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"follow_up":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"identify":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"dropout":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"scaling":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"effect_of_assistance":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]}},"required":["hardship_notice","information_request","decision_notice","decision_period","small_change","change_notice","default_notice","default_notice_content","default_notice_form","enforcement_hold","enforcement_hold_applies","postponement_request","postponement_hold","idr_hardship","idr_urgent","idr_reasons","generic_reasons","follow_up","identify","dropout","scaling","effect_of_assistance"]},"events":{"type":"object","properties":{"hardship_notice_identified":{"type":"string"},"information_requested":{"type":"string"},"information_received":{"type":"string"},"decision_notice_given":{"type":"string"},"agreement_reached":{"type":"string"},"change_notice_given":{"type":"string"},"default_notice_given":{"type":"string"},"earlier_hardship_notice":{"type":"string"},"complaint_received":{"type":"string"},"postponement_request":{"type":"string"},"postponement_notice_given":{"type":"string"},"contact_attempted":{"type":"string"},"withdrawn":{"type":"string"},"step_taken":{"type":"string"}},"required":["hardship_notice_identified","information_requested","information_received","decision_notice_given","agreement_reached","change_notice_given","default_notice_given","earlier_hardship_notice","complaint_received","postponement_request","postponement_notice_given","contact_attempted","withdrawn","step_taken"]},"record_fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"para":{"type":"string"},"asic":{"type":"string"},"what":{"type":"string"}},"required":["id","para","asic","what"]}},"record_vocabulary":{"type":"object","properties":{"source":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"action":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"channel":{"type":"object","properties":{"phone":{"type":"object","properties":{"label":{"type":"string"},"oral":{"type":"boolean"}},"required":["label","oral"]},"in_person":{"type":"object","properties":{"label":{"type":"string"},"oral":{"type":"boolean"}},"required":["label","oral"]},"online_form":{"type":"object","properties":{"label":{"type":"string"},"oral":{"type":"boolean"}},"required":["label","oral"]},"email":{"type":"object","properties":{"label":{"type":"string"},"oral":{"type":"boolean"}},"required":["label","oral"]},"letter":{"type":"object","properties":{"label":{"type":"string"},"oral":{"type":"boolean"}},"required":["label","oral"]},"sms":{"type":"object","properties":{"label":{"type":"string"},"oral":{"type":"boolean"}},"required":["label","oral"]},"other":{"type":"object","properties":{"label":{"type":"string"},"oral":{}},"required":["label","oral"]}},"required":["phone","in_person","online_form","email","letter","sms","other"]},"represented":{"type":"object","properties":{"financial_counsellor":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"other_representative":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"none":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]}},"required":["financial_counsellor","other_representative","none"]},"reason":{"type":"object","properties":{"note":{"type":"string"},"values":{"type":"object","properties":{"overcommitment":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"reduced_income":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"unemployment":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"medical":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"separation":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"bereavement":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"business_downturn":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"parental_leave":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"abuse":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"natural_disaster":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"other":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]}},"required":["overcommitment","reduced_income","unemployment","medical","separation","bereavement","business_downturn","parental_leave","abuse","natural_disaster","other"]}},"required":["note","values"]},"assistance":{"type":"object","properties":{"note":{"type":"string"},"values":{"type":"object","properties":{"deferral":{"type":"object","properties":{"label":{"type":"string"},"what":{"type":"string"}},"required":["label","what"]},"payment_arrangement":{"type":"object","properties":{"label":{"type":"string"},"what":{"type":"string"}},"required":["label","what"]},"interest_only":{"type":"object","properties":{"label":{"type":"string"},"what":{"type":"string"}},"required":["label","what"]},"term_extension":{"type":"object","properties":{"label":{"type":"string"},"what":{"type":"string"}},"required":["label","what"]},"capitalisation_of_arrears":{"type":"object","properties":{"label":{"type":"string"},"what":{"type":"string"}},"required":["label","what"]},"arrears_payment_arrangement":{"type":"object","properties":{"label":{"type":"string"},"what":{"type":"string"}},"required":["label","what"]},"serviceability_period":{"type":"object","properties":{"label":{"type":"string"},"what":{"type":"string"}},"required":["label","what"]},"interest_rate_reduction":{"type":"object","properties":{"label":{"type":"string"},"what":{"type":"string"}},"required":["label","what"]},"supported_sale":{"type":"object","properties":{"label":{"type":"string"},"what":{"type":"string"}},"required":["label","what"]},"other":{"type":"object","properties":{"label":{"type":"string"},"what":{"type":"string"}},"required":["label","what"]}},"required":["deferral","payment_arrangement","interest_only","term_extension","capitalisation_of_arrears","arrears_payment_arrangement","serviceability_period","interest_rate_reduction","supported_sale","other"]}},"required":["note","values"]},"declineReason":{"type":"string"}},"required":["source","action","channel","represented","reason","assistance","declineReason"]},"notice_ledger":{"type":"object","properties":{"states":{"type":"object","properties":{"recorded":{"type":"string"},"not_produced":{"type":"string"},"not_required":{"type":"string"},"cannot_tell":{"type":"string"}},"required":["recorded","not_produced","not_required","cannot_tell"]},"not_a_finding":{"type":"string"},"notices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"notice":{"type":"string"},"required_when":{"type":"string"},"is_a_permission_not_a_duty":{"type":"boolean"},"credit_contract":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]},"consumer_lease":{"type":"object","properties":{"cite":{"type":"string"},"quote":{"type":"string"}},"required":["cite","quote"]}},"required":["id","notice","required_when","is_a_permission_not_a_duty","credit_contract","consumer_lease"]}},"amendable_due_dates":{"type":"object","additionalProperties":{"type":"object","properties":{"what":{"type":"string"},"whose":{"type":"string"},"direction":{"type":"string"},"because":{"type":"string"},"doesNotMove":{"type":"object","properties":{"what":{"type":"string"},"why":{"type":"string"}},"required":["what","why"]}},"required":["what","whose","direction","because","doesNotMove"]}},"every_other_due_date":{"type":"string"}},"required":["states","not_a_finding","notices","amendable_due_dates","every_other_due_date"]},"what_is_not_here":{"type":"array","items":{"type":"string"}}},"required":["compilation","periods","hardship_lookback_is_calendar_months","credit_contract","consumer_lease","events","record_fields","record_vocabulary","notice_ledger","what_is_not_here"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/decisioning":{"get":{"operationId":"getDecisioning","tags":["Decisioning"],"summary":"A lender’s own credit policy, versioned and replayable against the version that was in force on the…","description":"A lender’s own credit policy, versioned and replayable against the version that was in force on the day.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/decisioning#get-v1-decisioning"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"what":{"type":"string"},"not_advice":{"type":"string"},"this_is_an_example":{"type":"string"},"nothing_is_kept":{"type":"string"},"endpoints":{"type":"object","additionalProperties":{"type":"object","properties":{"what":{"type":"string"},"query":{"type":"object","properties":{"policy":{"type":"string"},"income":{"type":"string"},"other":{"type":"string"},"rent":{"type":"string"},"everyday":{"type":"string"},"gambling":{"type":"string"},"benchmark":{"type":"string"},"declared":{"type":"string"},"debt":{"type":"string"},"gross":{"type":"string"},"amount":{"type":"string"},"rate":{"type":"string"},"years":{"type":"string"},"on":{"type":"string"},"tamper":{"type":"string"}},"required":["policy"]},"body":{"type":"string"}},"required":["what"]}},"engines":{"type":"object","properties":{"decisioning":{"type":"string"},"record":{"type":"string"}},"required":["decisioning","record"]},"example_policies":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"source":{"type":"string"},"compiled":{"type":"string"},"for_whom":{"type":"string"},"this_is_an_example":{"type":"string"}},"required":["key","label","source","compiled","for_whom","this_is_an_example"]}}},"required":["service","version","what","not_advice","this_is_an_example","nothing_is_kept","endpoints","engines","example_policies"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/decisioning/policy":{"get":{"operationId":"getDecisioningPolicy","tags":["Decisioning"],"summary":"One of the example policies on this surface","description":"One of the example policies on this surface: every version, its dates, the hash of its rules, and every clause in it.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/decisioning#get-v1-decisioning-policy"},"parameters":[{"name":"policy","in":"query","required":false,"description":"which example policy: round-numbers, guideline-shaped — default round-numbers","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"not_advice":{"type":"string"},"this_is_an_example":{"type":"string"},"example_policy":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"source":{"type":"string"},"for_whom":{"type":"string"}},"required":["key","label","source","for_whom"]},"also_available":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"source":{"type":"string"},"at":{"type":"string"}},"required":["key","label","source","at"]}},"policy":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"}},"required":["id","title"]},"in_force_today":{"type":"string"},"why_not":{},"versions":{"type":"array","items":{"type":"object","properties":{"version":{"type":"string"},"effective":{"type":"string"},"retired":{"type":["string","null"]},"hash":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}},"rules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"clause":{"type":"string"},"reason":{"type":"string"}},"required":["id","kind","clause","reason"]}}},"required":["version","effective","retired","hash","notes","rules"]}}},"required":["service","version","not_advice","this_is_an_example","example_policy","also_available","policy","in_force_today","why_not","versions"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/decisioning/replay":{"get":{"operationId":"getDecisioningReplay","tags":["Decisioning"],"summary":"One application run against the policy in force on the day it was assessed and against the policy…","description":"One application run against the policy in force on the day it was assessed and against the policy in force today, with every rule outcome and the evidence behind it.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/decisioning#get-v1-decisioning-replay"},"parameters":[{"name":"income","in":"query","required":false,"description":"monthly pay credited to the account, dollars","schema":{"type":"string"}},{"name":"other","in":"query","required":false,"description":"monthly income of a kind that is not wages — rental, dividends, side work — dollars. Nothing by default, and a figure here adds a second income stream to the invented statement, which is what a policy with a separate line per kind of income is about","schema":{"type":"string"}},{"name":"rent","in":"query","required":false,"description":"monthly rent, dollars","schema":{"type":"string"}},{"name":"everyday","in":"query","required":false,"description":"monthly card spending on groceries, fuel and utilities, dollars","schema":{"type":"string"}},{"name":"gambling","in":"query","required":false,"description":"monthly spending with a wagering operator, dollars","schema":{"type":"string"}},{"name":"benchmark","in":"query","required":false,"description":"the lender’s own monthly expense benchmark for this household, dollars — supplied by the lender, because this repository holds no benchmark table","schema":{"type":"string"}},{"name":"declared","in":"query","required":false,"description":"what the applicant said they spend each month, dollars","schema":{"type":"string"}},{"name":"debt","in":"query","required":false,"description":"every debt the lender counts, including the loan applied for, dollars — one half of the debt-to-income ratio, which this software does not define","schema":{"type":"string"}},{"name":"gross","in":"query","required":false,"description":"gross annual income before tax, dollars a year — the other half, and not a figure a bank statement carries","schema":{"type":"string"}},{"name":"amount","in":"query","required":false,"description":"the amount applied for, dollars","schema":{"type":"string"}},{"name":"rate","in":"query","required":false,"description":"the annual rate offered before the assessment buffer, per cent","schema":{"type":"string"}},{"name":"years","in":"query","required":false,"description":"the term applied for, years","schema":{"type":"string"}},{"name":"on","in":"query","required":false,"description":"the day the application was assessed, YYYY-MM-DD — which decides which version it is replayed against","schema":{"type":"string"}},{"name":"policy","in":"query","required":false,"description":"which example policy to replay against: round-numbers, guideline-shaped — default round-numbers. It also changes the day the example defaults to being assessed on, because the two policies changed on different days","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"engines":{"type":"object","properties":{"decisioning":{"type":"string"},"record":{"type":"string"}},"required":["decisioning","record"]},"not_advice":{"type":"string"},"this_is_an_example":{"type":"string"},"this_policy_is_an_example":{"type":"string"},"example_policy":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"source":{"type":"string"},"for_whom":{"type":"string"}},"required":["key","label","source","for_whom"]},"application":{"type":"object","properties":{"policy":{"type":"string"},"income":{"type":"number"},"other":{"type":"number"},"rent":{"type":"number"},"everyday":{"type":"number"},"gambling":{"type":"number"},"benchmark":{"type":"number"},"declared":{"type":"number"},"debt":{"type":"number"},"gross":{"type":"number"},"amount":{"type":"number"},"rate":{"type":"number"},"years":{"type":"number"},"assessedOn":{"type":"string"}},"required":["policy","income","other","rent","everyday","gambling","benchmark","declared","debt","gross","amount","rate","years","assessedOn"]},"statement":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"string"},"description":{"type":"string"},"amount":{"type":"number"}},"required":["id","date","description","amount"]}}},"required":["from","to","transactions"]},"debt_to_income":{"type":"object","properties":{"ratio":{"type":"number"},"total_debt":{"type":"number"},"gross_annual_income":{"type":"number"},"supplied_not_computed":{"type":"string"},"whose_threshold":{"type":"string"}},"required":["ratio","total_debt","gross_annual_income","supplied_not_computed","whose_threshold"]},"declared_expenses":{"type":"object","properties":{"declared_monthly":{"type":"number"},"benchmark_monthly":{"type":"number"},"share_of_benchmark":{"type":"number"},"supplied_not_computed":{"type":"string"}},"required":["declared_monthly","benchmark_monthly","share_of_benchmark","supplied_not_computed"]},"evidence_hash":{"type":"string"},"as_assessed":{"type":"object","properties":{"as_at":{"type":"string"},"policy":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"version":{"type":"string"},"effective":{"type":"string"},"retired":{"type":"string"},"hash":{"type":"string"},"rules":{"type":"number"},"notes":{"type":"array","items":{"type":"string"}}},"required":["id","title","version","effective","retired","hash","rules","notes"]},"conditions_met":{"type":"boolean"},"statement":{"type":"string"},"met":{"type":"array","items":{"type":"string"}},"not_met":{"type":"array"},"referrals":{"type":"array","items":{"type":"string"}},"unresolved":{"type":"array"},"not_applicable":{"type":"array"},"cautions":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string"},"says":{"type":"string"}},"required":["from","says"]}},"outcomes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"built_in":{"type":"boolean"},"clause":{"type":"string"},"requires":{"type":"string"},"measures":{"type":"string"},"outcome":{"type":"string"},"value":{"type":["number","boolean"]},"because":{"type":"string"},"policy_reason":{"type":"string"},"evidence":{"type":"object","properties":{"figures":{"type":"object","properties":{"gaps":{"type":"number"},"complete":{"type":"boolean"},"assessedIncome":{"type":"number"},"livingExpenses":{"type":"number"},"commitments":{"type":"number"},"proposedRepayment":{"type":"number"},"principal":{"type":"number"},"assessedAnnualIncome":{"type":"number"},"totalDebt":{"type":"number"},"grossAnnualIncome":{"type":"number"},"countedBy":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"categorised":{"type":"number"},"transactions":{"type":"number"},"verifiedMonthly":{"type":"number"},"inferredMonthly":{"type":"number"},"total":{"type":"number"},"count":{"type":"number"},"months":{"type":"number"}}},"transactions":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"description":{"type":"string"},"amount":{"type":"number"}},"required":["date","description","amount"]}},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","additionalProperties":{"type":["array","string","number","boolean"],"items":{"type":"string"}}}},"required":["step","what","amount","rule","inputs"]}}},"required":["figures","transactions","lines"]}},"required":["id","kind","built_in","clause","requires","measures","outcome","value","because","policy_reason","evidence"]}}},"required":["as_at","policy","conditions_met","statement","met","not_met","referrals","unresolved","not_applicable","cautions","outcomes"]},"as_the_policy_stands":{"type":"object","properties":{"as_at":{"type":"string"},"policy":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"version":{"type":"string"},"effective":{"type":"string"},"retired":{},"hash":{"type":"string"},"rules":{"type":"number"},"notes":{"type":"array","items":{"type":"string"}}},"required":["id","title","version","effective","retired","hash","rules","notes"]},"conditions_met":{"type":"boolean"},"statement":{"type":"string"},"met":{"type":"array","items":{"type":"string"}},"not_met":{"type":"array","items":{"type":"string"}},"referrals":{"type":"array","items":{"type":"string"}},"unresolved":{"type":"array"},"not_applicable":{"type":"array"},"cautions":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string"},"says":{"type":"string"}},"required":["from","says"]}},"outcomes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"built_in":{"type":"boolean"},"clause":{"type":"string"},"requires":{"type":"string"},"measures":{"type":"string"},"outcome":{"type":"string"},"value":{"type":["number","boolean"]},"because":{"type":"string"},"policy_reason":{"type":"string"},"evidence":{"type":"object","properties":{"figures":{"type":"object","properties":{"gaps":{"type":"number"},"complete":{"type":"boolean"},"assessedIncome":{"type":"number"},"livingExpenses":{"type":"number"},"commitments":{"type":"number"},"proposedRepayment":{"type":"number"},"principal":{"type":"number"},"assessedAnnualIncome":{"type":"number"},"totalDebt":{"type":"number"},"grossAnnualIncome":{"type":"number"},"countedBy":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"categorised":{"type":"number"},"transactions":{"type":"number"},"verifiedMonthly":{"type":"number"},"inferredMonthly":{"type":"number"},"total":{"type":"number"},"count":{"type":"number"},"months":{"type":"number"}}},"transactions":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"description":{"type":"string"},"amount":{"type":"number"}},"required":["date","description","amount"]}},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","additionalProperties":{"type":["array","string","number","boolean"],"items":{"type":"string"}}}},"required":["step","what","amount","rule","inputs"]}}},"required":["figures","transactions","lines"]}},"required":["id","kind","built_in","clause","requires","measures","outcome","value","because","policy_reason","evidence"]}}},"required":["as_at","policy","conditions_met","statement","met","not_met","referrals","unresolved","not_applicable","cautions","outcomes"]},"what_changed":{"type":"object","properties":{"policy":{"type":"string"},"from":{"type":"object","properties":{"version":{"type":"string"},"effective":{"type":"string"},"hash":{"type":"string"}},"required":["version","effective","hash"]},"to":{"type":"object","properties":{"version":{"type":"string"},"effective":{"type":"string"},"hash":{"type":"string"}},"required":["version","effective","hash"]},"added":{"type":"array"},"removed":{"type":"array"},"changed":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"was":{"type":"object","properties":{"kind":{"type":"string"},"wrote":{"type":"string"},"reason":{"type":"string"},"stage":{"type":"string"}},"required":["kind","wrote","reason","stage"]},"now":{"type":"object","properties":{"kind":{"type":"string"},"wrote":{"type":"string"},"reason":{"type":"string"},"stage":{"type":"string"}},"required":["kind","wrote","reason","stage"]},"says":{"type":"string"}},"required":["id","was","now","says"]}},"unchanged":{"type":"number"},"notes":{"type":"array","items":{"type":"string"}},"statement":{"type":"string"}},"required":["policy","from","to","added","removed","changed","unchanged","notes","statement"]},"rule_by_rule":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"builtIn":{"type":"boolean"},"then":{"type":"object","properties":{"outcome":{"type":"string"},"condition":{"type":"string"},"value":{"type":["number","boolean"]},"because":{"type":"string"}},"required":["outcome","condition","value","because"]},"now":{"type":"object","properties":{"outcome":{"type":"string"},"condition":{"type":"string"},"value":{"type":["number","boolean"]},"because":{"type":"string"}},"required":["outcome","condition","value","because"]},"answerChanged":{"type":"boolean"},"clauseChanged":{"type":"boolean"},"kindChanged":{"type":"boolean"},"reworded":{"type":"boolean"},"clause":{"type":["object","null"],"properties":{"id":{"type":"string"},"was":{"type":"object","properties":{"kind":{"type":"string"},"wrote":{"type":"string"},"reason":{"type":"string"},"stage":{"type":"string"}},"required":["kind","wrote","reason","stage"]},"now":{"type":"object","properties":{"kind":{"type":"string"},"wrote":{"type":"string"},"reason":{"type":"string"},"stage":{"type":"string"}},"required":["kind","wrote","reason","stage"]},"says":{"type":"string"}},"required":["id","was","now","says"]},"status":{"type":"string"}},"required":["id","kind","builtIn","then","now","answerChanged","clauseChanged","kindChanged","reworded","clause","status"]}},"finding":{"type":"string"},"not_a_decision":{"type":"string"},"could_not_read":{"type":"array"}},"required":["service","version","engines","not_advice","this_is_an_example","this_policy_is_an_example","example_policy","application","statement","debt_to_income","declared_expenses","evidence_hash","as_assessed","as_the_policy_stands","what_changed","rule_by_rule","finding","not_a_decision","could_not_read"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/decisioning/record":{"get":{"operationId":"getDecisioningRecord","tags":["Record"],"summary":"The same application sealed into a record, verified, amended by appending, and edited so the…","description":"The same application sealed into a record, verified, amended by appending, and edited so the verification fails.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/record#get-v1-decisioning-record"},"parameters":[{"name":"tamper","in":"query","required":false,"description":"which field to alter: surplus, debt-to-income, verdict, assessor, sealed-at, delete-evidence — default surplus","schema":{"type":"string"}},{"name":"policy","in":"query","required":false,"description":"which example policy the record was assessed under: round-numbers, guideline-shaped — default round-numbers","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"not_advice":{"type":"string"},"this_is_an_example":{"type":"string"},"nothing_is_kept":{"type":"string"},"sealed":{"type":"object","properties":{"id":{"type":"string"},"algorithm":{"type":"string"},"sealedAt":{"type":"string"},"record":{"type":"object","properties":{"recordVersion":{"type":"string"},"applicant":{"type":"string"},"product":{"type":"string"},"inquiries":{"type":"array","items":{"type":"object","properties":{"asked":{"type":"string"},"answer":{"type":"string"},"at":{"type":"string"}},"required":["asked","answer","at"]}},"verification":{"type":"object","properties":{"statementFrom":{"type":"string"},"statementTo":{"type":"string"},"transactions":{"type":"number"},"categorised":{"type":"number"},"enoughHistory":{"type":"boolean"},"verifiedMonthlyIncome":{"type":"number"},"inferredMonthlyIncome":{"type":"number"},"monthlyOutgoings":{"type":"number"},"monthlyCommitments":{"type":"number"},"incomeStreams":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"period":{"type":"string"},"monthly":{"type":"number"},"payments":{"type":"number"},"confidence":{"type":"number"},"inferred":{"type":"boolean"}},"required":["description","period","monthly","payments","confidence","inferred"]}},"incomeReconciliation":{},"signals":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"severity":{"type":"string"},"statement":{"type":"string"},"count":{"type":"number"}},"required":["code","severity","statement","count"]}},"couldNotRead":{"type":"array"},"engine":{"type":"string"}},"required":["statementFrom","statementTo","transactions","categorised","enoughHistory","verifiedMonthlyIncome","inferredMonthlyIncome","monthlyOutgoings","monthlyCommitments","incomeStreams","incomeReconciliation","signals","couldNotRead","engine"]},"assessment":{"type":"object","properties":{"assessmentRate":{"type":"number"},"assessedIncome":{"type":"number"},"livingExpenses":{"type":"number"},"commitments":{"type":"number"},"proposedRepayment":{"type":"number"},"monthlySurplus":{"type":"number"},"netSurplusRatio":{"type":"number"},"debtServiceRatio":{"type":"number"},"dti":{"type":"object","properties":{"version":{"type":"string"},"totalDebt":{"type":"number"},"grossAnnualIncome":{},"ratio":{},"threshold":{"type":"number"},"atOrAbove":{},"headroom":{},"incomeAtThreshold":{"type":"number"},"unpriced":{"type":"array"},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","properties":{"principal":{"type":"number"},"monthly":{"type":"number"},"category":{"type":"string"},"transactions":{"type":"array","items":{"type":"string"}}}}},"required":["step","what","amount","rule","inputs"]}},"gaps":{"type":"array","items":{"type":"string"}},"position":{"type":"string"},"said":{"type":"string"},"apra":{"type":"object","properties":{"threshold":{"type":"number"},"share":{"type":"number"},"since":{"type":"string"},"basis":{"type":"string"}},"required":["threshold","share","since","basis"]},"complete":{"type":"boolean"}},"required":["version","totalDebt","grossAnnualIncome","ratio","threshold","atOrAbove","headroom","incomeAtThreshold","unpriced","lines","gaps","position","said","apra","complete"]},"complete":{"type":"boolean"},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","additionalProperties":{"type":["array","string","number","boolean"],"items":{"type":"string"}}}},"required":["step","what","amount","rule","inputs"]}},"gaps":{"type":"array","items":{"type":"string"}},"engine":{"type":"string"}},"required":["assessmentRate","assessedIncome","livingExpenses","commitments","proposedRepayment","monthlySurplus","netSurplusRatio","debtServiceRatio","dti","complete","lines","gaps","engine"]},"capacity":{},"conclusion":{"type":"object","properties":{"verdict":{"type":"string"},"means":{"type":"string"},"reasons":{"type":"string"},"by":{"type":"string"},"at":{"type":"string"}},"required":["verdict","means","reasons","by","at"]},"supersedes":{},"amendment":{},"extra":{"type":"object","properties":{"debtToIncome":{"type":"object","properties":{"ratio":{"type":"number"},"totalDebt":{"type":"number"},"grossAnnualIncome":{"type":"number"},"source":{"type":"string"}},"required":["ratio","totalDebt","grossAnnualIncome","source"]},"expenses":{"type":"object","properties":{"declared":{"type":"number"},"benchmark":{"type":"number"},"source":{"type":"string"}},"required":["declared","benchmark","source"]},"policyRun":{"type":"object","properties":{"policy":{"type":"string"},"version":{"type":"string"},"effective":{"type":"string"},"hash":{"type":"string"},"conditionsMet":{"type":"boolean"},"statement":{"type":"string"},"met":{"type":"array","items":{"type":"string"}},"notMet":{"type":"array"},"referrals":{"type":"array","items":{"type":"string"}},"unresolved":{"type":"array"}},"required":["policy","version","effective","hash","conditionsMet","statement","met","notMet","referrals","unresolved"]},"example":{"type":"string"},"examplePolicy":{"type":"string"}},"required":["debtToIncome","expenses","policyRun","example","examplePolicy"]},"sealedAt":{"type":"string"}},"required":["recordVersion","applicant","product","inquiries","verification","assessment","capacity","conclusion","supersedes","amendment","extra","sealedAt"]}},"required":["id","algorithm","sealedAt","record"]},"verification":{"type":"object","properties":{"valid":{"type":"boolean"},"expected":{"type":"string"},"actual":{"type":"string"}},"required":["valid","expected","actual"]},"amendment":{"type":"object","properties":{"id":{"type":"string"},"algorithm":{"type":"string"},"sealedAt":{"type":"string"},"record":{"type":"object","properties":{"recordVersion":{"type":"string"},"applicant":{"type":"string"},"product":{"type":"string"},"inquiries":{"type":"array","items":{"type":"object","properties":{"asked":{"type":"string"},"answer":{"type":"string"},"at":{"type":"string"}},"required":["asked","answer","at"]}},"verification":{"type":"object","properties":{"statementFrom":{"type":"string"},"statementTo":{"type":"string"},"transactions":{"type":"number"},"categorised":{"type":"number"},"enoughHistory":{"type":"boolean"},"verifiedMonthlyIncome":{"type":"number"},"inferredMonthlyIncome":{"type":"number"},"monthlyOutgoings":{"type":"number"},"monthlyCommitments":{"type":"number"},"incomeStreams":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"period":{"type":"string"},"monthly":{"type":"number"},"payments":{"type":"number"},"confidence":{"type":"number"},"inferred":{"type":"boolean"}},"required":["description","period","monthly","payments","confidence","inferred"]}},"incomeReconciliation":{},"signals":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"severity":{"type":"string"},"statement":{"type":"string"},"count":{"type":"number"}},"required":["code","severity","statement","count"]}},"couldNotRead":{"type":"array"},"engine":{"type":"string"}},"required":["statementFrom","statementTo","transactions","categorised","enoughHistory","verifiedMonthlyIncome","inferredMonthlyIncome","monthlyOutgoings","monthlyCommitments","incomeStreams","incomeReconciliation","signals","couldNotRead","engine"]},"assessment":{"type":"object","properties":{"assessmentRate":{"type":"number"},"assessedIncome":{"type":"number"},"livingExpenses":{"type":"number"},"commitments":{"type":"number"},"proposedRepayment":{"type":"number"},"monthlySurplus":{"type":"number"},"netSurplusRatio":{"type":"number"},"debtServiceRatio":{"type":"number"},"dti":{"type":"object","properties":{"version":{"type":"string"},"totalDebt":{"type":"number"},"grossAnnualIncome":{},"ratio":{},"threshold":{"type":"number"},"atOrAbove":{},"headroom":{},"incomeAtThreshold":{"type":"number"},"unpriced":{"type":"array"},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","properties":{"principal":{"type":"number"},"monthly":{"type":"number"},"category":{"type":"string"},"transactions":{"type":"array","items":{"type":"string"}}}}},"required":["step","what","amount","rule","inputs"]}},"gaps":{"type":"array","items":{"type":"string"}},"position":{"type":"string"},"said":{"type":"string"},"apra":{"type":"object","properties":{"threshold":{"type":"number"},"share":{"type":"number"},"since":{"type":"string"},"basis":{"type":"string"}},"required":["threshold","share","since","basis"]},"complete":{"type":"boolean"}},"required":["version","totalDebt","grossAnnualIncome","ratio","threshold","atOrAbove","headroom","incomeAtThreshold","unpriced","lines","gaps","position","said","apra","complete"]},"complete":{"type":"boolean"},"lines":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string"},"what":{"type":"string"},"amount":{"type":"number"},"rule":{"type":"string"},"inputs":{"type":"object","additionalProperties":{"type":["array","string","number","boolean"],"items":{"type":"string"}}}},"required":["step","what","amount","rule","inputs"]}},"gaps":{"type":"array","items":{"type":"string"}},"engine":{"type":"string"}},"required":["assessmentRate","assessedIncome","livingExpenses","commitments","proposedRepayment","monthlySurplus","netSurplusRatio","debtServiceRatio","dti","complete","lines","gaps","engine"]},"capacity":{},"conclusion":{"type":"object","properties":{"verdict":{"type":"string"},"means":{"type":"string"},"reasons":{"type":"string"},"by":{"type":"string"},"at":{"type":"string"}},"required":["verdict","means","reasons","by","at"]},"supersedes":{"type":"string"},"amendment":{"type":"object","properties":{"reason":{"type":"string"},"supersedes":{"type":"string"}},"required":["reason","supersedes"]},"extra":{"type":"object","properties":{"debtToIncome":{"type":"object","properties":{"ratio":{"type":"number"},"totalDebt":{"type":"number"},"grossAnnualIncome":{"type":"number"},"source":{"type":"string"}},"required":["ratio","totalDebt","grossAnnualIncome","source"]},"expenses":{"type":"object","properties":{"declared":{"type":"number"},"benchmark":{"type":"number"},"source":{"type":"string"}},"required":["declared","benchmark","source"]},"policyRun":{"type":"object","properties":{"policy":{"type":"string"},"version":{"type":"string"},"effective":{"type":"string"},"hash":{"type":"string"},"conditionsMet":{"type":"boolean"},"statement":{"type":"string"},"met":{"type":"array","items":{"type":"string"}},"notMet":{"type":"array"},"referrals":{"type":"array","items":{"type":"string"}},"unresolved":{"type":"array"}},"required":["policy","version","effective","hash","conditionsMet","statement","met","notMet","referrals","unresolved"]},"example":{"type":"string"},"examplePolicy":{"type":"string"}},"required":["debtToIncome","expenses","policyRun","example","examplePolicy"]},"sealedAt":{"type":"string"}},"required":["recordVersion","applicant","product","inquiries","verification","assessment","capacity","conclusion","supersedes","amendment","extra","sealedAt"]}},"required":["id","algorithm","sealedAt","record"]},"chain":{"type":"object","properties":{"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sealed_at":{"type":"string"},"supersedes":{"type":["string","null"]}},"required":["id","sealed_at","supersedes"]}},"check":{"type":"object","properties":{"valid":{"type":"boolean"},"problems":{"type":"array"},"length":{"type":"number"}},"required":["valid","problems","length"]}},"required":["entries","check"]},"tampered":{"type":"object","properties":{"what_was_changed":{"type":"string"},"before":{"type":"string"},"after":{"type":"string"},"verification":{"type":"object","properties":{"valid":{"type":"boolean"},"expected":{"type":"string"},"actual":{"type":"string"},"reason":{"type":"string"}},"required":["valid","expected","actual","reason"]},"chain":{"type":"object","properties":{"valid":{"type":"boolean"},"problems":{"type":"array","items":{"type":"string"}},"length":{"type":"number"}},"required":["valid","problems","length"]},"detected":{"type":"boolean"}},"required":["what_was_changed","before","after","verification","chain","detected"]}},"required":["service","version","not_advice","this_is_an_example","nothing_is_kept","sealed","verification","amendment","chain","tampered"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]}},"/v1/decisioning/run":{"post":{"operationId":"postDecisioningRun","tags":["Decisioning"],"summary":"A lender’s own policy","description":"A lender’s own policy — its text, or a policy already sealed — read, sealed and run on one application as it stood on a day. Every rule’s outcome comes back with its reason; nothing is kept.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/decisioning#post-v1-decisioning-run"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{policy: \"policy text\" | {id, versions: [...]}, application: {reading?, assessment?, proposal?, answers?, verification?, history?, smallAmount?}, on: \"YYYY-MM-DD\"}","content":{"application/json":{"schema":{"type":"object","description":"{policy: \"policy text\" | {id, versions: [...]}, application: {reading?, assessment?, proposal?, answers?, verification?, history?, smallAmount?}, on: \"YYYY-MM-DD\"}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"policy":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"versions":{"type":"array","items":{"type":"object","properties":{"version":{"type":"string"},"effective":{"type":"string"},"retired":{},"hash":{"type":"string"},"rules":{"type":"number"}},"required":["version","effective","retired","hash","rules"]}}},"required":["id","title","versions"]},"on":{"type":"string"},"ran":{"type":"object","properties":{"engine":{"type":"string"},"policy":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"version":{"type":"string"},"effective":{"type":"string"},"retired":{},"hash":{"type":"string"},"rules":{"type":"number"},"notes":{"type":"array"}},"required":["id","title","version","effective","retired","hash","rules","notes"]},"applicant":{},"ranAt":{"type":"string"},"outcomes":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"},"field":{"type":"string"},"param":{},"condition":{"type":"string"},"requires":{"type":"string"},"reason":{"type":"string"},"basis":{},"measures":{"type":"string"},"outcome":{"type":"string"},"value":{"type":"number"},"because":{"type":"string"},"evidence":{"type":"object","properties":{"figures":{"type":"object","properties":{"excludes":{"type":"string"},"streams":{"type":"number"},"inferredMonthly":{"type":"number"}}},"from":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"description":{"type":"string"},"amount":{"type":"number"}},"required":["date","description","amount"]}}},"required":["figures","from"]}},"required":["kind","id","field","param","condition","requires","reason","basis","measures","outcome","value","because","evidence"]}},"met":{"type":"array","items":{"type":"string"}},"notMet":{"type":"array"},"referrals":{"type":"array"},"unresolved":{"type":"array"},"staff":{"type":"array"},"notApplicable":{"type":"array"},"stage":{},"conditionsMet":{"type":"boolean"},"statement":{"type":"string"},"bases":{"type":"array"},"cautions":{"type":"array"},"forTheAssessor":{"type":"string"}},"required":["engine","policy","applicant","ranAt","outcomes","met","notMet","referrals","unresolved","staff","notApplicable","stage","conditionsMet","statement","bases","cautions","forTheAssessor"]},"not_a_decision":{"type":"string"}},"required":["policy","on","ran","not_a_decision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/decisioning/shadow":{"post":{"operationId":"postDecisioningShadow","tags":["Decisioning"],"summary":"A candidate policy run beside the current one on the same applications, and each set beside the…","description":"A candidate policy run beside the current one on the same applications, and each set beside the conclusion a person recorded, so a change can be piloted before anybody relies on it.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/decisioning#post-v1-decisioning-shadow"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"description":"{policy, candidate, on?, applications: [{application, on?, conclusion?, by?, applicant?}]}","content":{"application/json":{"schema":{"type":"object","description":"{policy, candidate, on?, applications: [{application, on?, conclusion?, by?, applicant?}]}"}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"policy":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"versions":{"type":"array","items":{"type":"object","properties":{"version":{"type":"string"},"effective":{"type":"string"},"retired":{},"hash":{"type":"string"},"rules":{"type":"number"}},"required":["version","effective","retired","hash","rules"]}}},"required":["id","title","versions"]},"candidate":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"versions":{"type":"array","items":{"type":"object","properties":{"version":{"type":"string"},"effective":{"type":"string"},"retired":{},"hash":{"type":"string"},"rules":{"type":"number"}},"required":["version","effective","retired","hash","rules"]}}},"required":["id","title","versions"]},"current":{"type":"object","properties":{"files":{"type":"number"},"compared":{"type":"number"},"agreed":{"type":"number"},"agreement":{"type":"number"},"disagreements":{"type":"array"},"notCompared":{"type":"array"},"rows":{"type":"array","items":{"type":"object","properties":{"n":{"type":"number"},"applicant":{"type":"string"},"policy":{"type":"string"},"conclusion":{"type":"string"},"by":{"type":"string"},"agrees":{"type":"boolean"},"notMet":{"type":"array"},"unresolved":{"type":"array"},"referrals":{"type":"array"},"says":{"type":"string"}},"required":["n","applicant","policy","conclusion","by","agrees","notMet","unresolved","referrals","says"]}},"says":{"type":"string"},"notADecision":{"type":"string"}},"required":["files","compared","agreed","agreement","disagreements","notCompared","rows","says","notADecision"]},"shadow":{"type":"object","properties":{"files":{"type":"number"},"compared":{"type":"number"},"agreed":{"type":"number"},"agreement":{"type":"number"},"disagreements":{"type":"array"},"notCompared":{"type":"array"},"rows":{"type":"array","items":{"type":"object","properties":{"n":{"type":"number"},"applicant":{"type":"string"},"policy":{"type":"string"},"conclusion":{"type":"string"},"by":{"type":"string"},"agrees":{"type":"boolean"},"notMet":{"type":"array"},"unresolved":{"type":"array"},"referrals":{"type":"array","items":{"type":"string"}},"says":{"type":"string"}},"required":["n","applicant","policy","conclusion","by","agrees","notMet","unresolved","referrals","says"]}},"says":{"type":"string"},"notADecision":{"type":"string"}},"required":["files","compared","agreed","agreement","disagreements","notCompared","rows","says","notADecision"]},"changed":{"type":"array","items":{"type":"object","properties":{"applicant":{"type":"string"},"on":{"type":"string"},"current":{"type":"object","properties":{"conditionsMet":{"type":"boolean"},"notMet":{"type":"array"},"referrals":{"type":"array"}},"required":["conditionsMet","notMet","referrals"]},"candidate":{"type":"object","properties":{"conditionsMet":{"type":"boolean"},"notMet":{"type":"array"},"referrals":{"type":"array","items":{"type":"string"}}},"required":["conditionsMet","notMet","referrals"]}},"required":["applicant","on","current","candidate"]}},"says":{"type":"string"}},"required":["policy","candidate","current","shadow","changed","says"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/shadow":{"get":{"operationId":"getShadow","tags":["Decisioning"],"summary":"Run Creditcrest beside your own process before going live","description":"Run Creditcrest beside your own process before going live: your applications read, your policy and the Creditcrest Score run on them, and each set beside the decision you made.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/decisioning#get-v1-shadow"},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"string"},"version":{"type":"string"},"what":{"type":"string"},"not_a_decision":{"type":"string"},"stores":{"type":"string"},"endpoints":{"type":"object","additionalProperties":{"type":"object","properties":{"what":{"type":"string"},"body":{"type":"object","additionalProperties":{"type":"string"}}},"required":["what","body"]}},"tenant_setting":{"type":"string"},"page":{"type":"string"}},"required":["service","version","what","not_a_decision","stores","endpoints","tenant_setting","page"]}}}},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[]},"post":{"operationId":"postShadow","tags":["Decisioning"],"summary":"Up to 50 of your applications, each with your own outcome","description":"Up to 50 of your applications, each with your own outcome: the statement read, your policy and the score run on it, and a sealed comparison of where Creditcrest’s reading and your decision agree and part, with the rules, figures and transactions behind each difference. A report over the batch comes with them.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/decisioning#post-v1-shadow"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"applications":{"description":"[{ reference, on?: \"YYYY-MM-DD\", statement, answers?, checks?, history?, commitment?, lender: { outcome, amount?, termMonths?, frequency?, reasons?, figures? } }] — up to 50"},"statement":{"description":"the CSV your applicant’s bank exported, as text or { \"csv\", \"holders\"? }; or bank data { \"accounts\", \"transactions\", \"holderName\"? }"},"answers":{"description":"the application’s answers by the question keys of Creditcrest’s application form (loan.amount, income.amount…) or their canonical names (requested_amount…) — optional; restricted answers are dropped unread"},"checks":{"description":"what your own checks found: identityVerified, contactVerified, age or dateOfBirth, residencyCriteriaMet, requirementsAndObjectivesMet, accountNameMatches, allIncomeAccountsIncluded"},"history":{"description":"\"none\" for a first loan with you, or { contracts, paidLate, dishonours, worstDaysPastDue, complete }"},"lender.outcome":{"description":"approved, declined, referred or withdrawn — yours; Creditcrest does not approve or decline"},"lender.figures":{"description":"{ per: week | fortnight | month | year, income?, living?, housing?, credit?, commitments? } — compared as monthly figures, and only with their period"},"policy":{"description":"your policy’s text, optional: otherwise the one in your configuration, or Creditcrest’s starting policy"},"products":{"description":"your products, optional, in the shape of a lender’s configuration: the small and medium loan checks need them"},"on":{"description":"the day an application is assessed as, when it gives none; today in Sydney if left out"},"setting":{"description":"strict, balanced or broad, optional: how far each statement is read past the rules. Otherwise your configuration’s (journey.statementSetting), balanced unless set — so a run can show what another setting would have read before you change yours"}}}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"lender":{"type":"string"},"mode":{"type":"string"},"shadow":{"type":["boolean","null"]},"policy":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"versions":{"type":"array","items":{"type":"object","properties":{"version":{"type":"string"},"effective":{"type":"string"},"retired":{"type":["string","null"]}},"required":["version","effective","retired"]}},"source":{"type":"string"}},"required":["id","title","versions","source"]},"products":{"type":"string"},"setting":{"type":"object","properties":{"name":{"type":"string"},"target":{"type":["number","null"]},"floor":{"type":"number"},"modelled":{"type":"boolean"},"says":{"type":"string"},"source":{"type":"string"}},"required":["name","target","floor","modelled","says","source"]},"comparisons":{"type":"array","items":{"type":"object","properties":{"version":{"type":"string"},"reference":{"type":"string"},"on":{"type":"string"},"lender":{"type":"object","properties":{"outcome":{"type":"string"},"amount":{"type":["number","null"]},"termMonths":{"type":["number","null"]},"frequency":{},"reasons":{"type":"array"},"figuresPer":{},"figures":{"type":"object","properties":{}}},"required":["outcome","amount","termMonths","frequency","reasons","figuresPer","figures"]},"creditcrest":{"type":"object","properties":{"route":{"type":"string"},"partly":{"type":"boolean"},"says":{"type":"string"},"policy":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"hash":{"type":"string"},"outcome":{"type":"string"}},"required":["id","version","hash","outcome"]},"notMet":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"kind":{"type":"string"},"condition":{"type":"string"},"value":{"type":"number"},"because":{"type":"string"},"figures":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]},"from":{"type":"array"}},"required":["rule","kind","condition","value","because","figures","from"]}},"referred":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"kind":{"type":"string"},"condition":{"type":"string"},"value":{"type":"number"},"because":{"type":"string"},"figures":{"type":"object","properties":{"statementEnds":{"type":"string"},"ranOn":{"type":"string"}},"required":["statementEnds","ranOn"]},"from":{"type":"array"}},"required":["rule","kind","condition","value","because","figures","from"]}},"untested":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"kind":{"type":"string"},"condition":{"type":"string"},"why":{"type":"string"}},"required":["rule","kind","condition","why"]}},"staff":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"kind":{"type":"string"},"condition":{"type":"string"}},"required":["rule","kind","condition"]}},"notApplicable":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"kind":{"type":"string"},"condition":{"type":"string"},"why":{"type":"string"}},"required":["rule","kind","condition","why"]}},"provisional":{"type":["object","null"],"properties":{"provisional":{"type":"string"},"monthlySurplus":{"type":"number"},"income":{"type":"number"},"living":{"type":"number"},"commitments":{"type":"number"},"repayment":{"type":"number"},"loading":{"type":"number"},"loan":{"type":"object","properties":{"amount":{"type":"number"},"termMonths":{"type":"number"},"frequency":{"type":"string"},"firstRepaymentOn":{"type":"string"}},"required":["amount","termMonths","frequency","firstRepaymentOn"]}},"required":["provisional","monthlySurplus","income","living","commitments","repayment","loading","loan"]},"score":{"type":"object","properties":{"scored":{"type":"boolean"},"scale":{"type":"string"},"rating":{"type":"number"},"riskClass":{"type":"string"},"calibrated":{"type":"boolean"}},"required":["scored","scale","rating","riskClass","calibrated"]},"suggestion":{"type":["object","null"],"properties":{"amount":{"type":"number"},"termMonths":{"type":"number"}},"required":["amount","termMonths"]},"requestFrom":{"type":["string","null"]},"statement":{"type":"object","properties":{"source":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"days":{"type":"number"},"transactions":{"type":"number"},"categorisedByMoney":{"type":"number"},"readingHash":{"type":"string"},"setting":{"type":"string"},"ageDays":{"type":"number"}},"required":["source","from","to","days","transactions","categorisedByMoney","readingHash","setting","ageDays"]}},"required":["route","partly","says","policy","notMet","referred","untested","staff","notApplicable","provisional","score","suggestion","requestFrom","statement"]},"outcome":{"type":"object","properties":{"match":{"type":"string"},"says":{"type":"string"},"rules":{"type":"array","items":{"type":"string"}},"reasons":{"type":"array"},"amount":{"type":["object","null"],"properties":{"yours":{"type":"number"},"suggested":{"type":"number"},"difference":{"type":"number"}},"required":["yours","suggested","difference"]}},"required":["match","says","rules","reasons","amount"]},"figures":{"type":"array"},"couldNotRead":{"type":"array","items":{"type":"object","properties":{"what":{"type":"string"},"why":{"type":"string"}},"required":["what","why"]}},"notADecision":{"type":"string"},"seal":{"type":"object","properties":{"alg":{"type":"string"},"over":{"type":"string"},"hash":{"type":"string"},"signed":{"type":"object","properties":{"alg":{"type":"string"},"by":{"type":"string"},"value":{"type":"string"}},"required":["alg","by","value"]}},"required":["alg","over","hash","signed"]}},"required":["version","reference","on","lender","creditcrest","outcome","figures","couldNotRead","notADecision","seal"]}},"report":{"type":"object","properties":{"version":{"type":"string"},"period":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"days":{"type":"number"}},"required":["from","to","days"]},"count":{"type":"number"},"outcome":{"type":"object","properties":{"compared":{"type":"number"},"agree":{"type":"number"},"refer":{"type":"number"},"opposite":{"type":"number"},"notCompared":{"type":"number"},"agreement":{"type":"number"},"onFullEvidence":{"type":"object","properties":{"compared":{"type":"number"},"agree":{"type":"number"},"agreement":{"type":["number","null"]}},"required":["compared","agree","agreement"]},"table":{"type":"object","properties":{"approved":{"type":"object","additionalProperties":{"type":"number"}},"declined":{"type":"object","additionalProperties":{"type":"number"}},"referred":{"type":"object","additionalProperties":{"type":"number"}},"withdrawn":{"type":"object","additionalProperties":{"type":"number"}}},"required":["approved","declined","referred","withdrawn"]}},"required":["compared","agree","refer","opposite","notCompared","agreement","onFullEvidence","table"]},"rules":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"kind":{"type":"string"},"condition":{"type":"string"},"times":{"type":"number"},"where":{"type":"object","additionalProperties":{"type":"number"}}},"required":["rule","kind","condition","times","where"]}},"reasons":{"type":"array"},"figures":{"type":"object","properties":{}},"score":{"type":"object","properties":{"approved":{"type":"object","properties":{"scored":{"type":"number"},"rating":{"type":"number"},"classes":{"type":"object","properties":{"BBB":{"type":"number"},"BB":{"type":"number"}}}},"required":["scored","rating","classes"]}},"required":["approved"]},"amounts":{"type":["object","null"],"properties":{"compared":{"type":"number"},"suggestedLess":{"type":"number"},"suggestedMore":{"type":"number"},"difference":{"type":"object","properties":{"median":{"type":"number"},"p25":{"type":"number"},"p75":{"type":"number"}},"required":["median","p25","p75"]}},"required":["compared","suggestedLess","suggestedMore","difference"]},"coverage":{"type":"object","properties":{"statementsRead":{"type":"number"},"statementsNotRead":{"type":"number"},"categorisedByMoney":{"type":"object","properties":{"median":{"type":"number"},"lowest":{"type":"number"}},"required":["median","lowest"]},"untested":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"kind":{"type":"string"},"condition":{"type":"string"},"times":{"type":"number"},"why":{"type":"string"}},"required":["rule","kind","condition","times","why"]}},"staff":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"kind":{"type":"string"},"condition":{"type":"string"},"times":{"type":"number"}},"required":["rule","kind","condition","times"]}},"notApplicable":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"kind":{"type":"string"},"condition":{"type":"string"},"times":{"type":"number"},"why":{"type":"string"}},"required":["rule","kind","condition","times","why"]}},"notRead":{"type":"array","items":{"type":"object","properties":{"what":{"type":"string"},"times":{"type":"number"}},"required":["what","times"]}}},"required":["statementsRead","statementsNotRead","categorisedByMoney","untested","staff","notApplicable","notRead"]},"disagreements":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"on":{"type":"string"},"lender":{"type":"string"},"creditcrest":{"type":"string"},"match":{"type":"string"},"says":{"type":"string"}},"required":["reference","on","lender","creditcrest","match","says"]}},"comparisons":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"on":{"type":"string"},"hash":{"type":"string"}},"required":["reference","on","hash"]}},"refused":{"type":"array"},"says":{"type":"string"},"notADecision":{"type":"string"},"seal":{"type":"object","properties":{"alg":{"type":"string"},"over":{"type":"string"},"hash":{"type":"string"},"signed":{"type":"object","properties":{"alg":{"type":"string"},"by":{"type":"string"},"value":{"type":"string"}},"required":["alg","by","value"]}},"required":["alg","over","hash","signed"]}},"required":["version","period","count","outcome","rules","reasons","figures","score","amounts","coverage","disagreements","comparisons","refused","says","notADecision","seal"]},"kept":{"type":"object","properties":{"where":{"type":["string","null"]},"why":{"type":"string"},"streams":{"type":"array","items":{"type":"string"}},"added":{"type":"number"},"alreadyKept":{"type":"number"}},"required":["where","why"]},"not_a_decision":{"type":"string"}},"required":["lender","mode","shadow","policy","products","setting","comparisons","report","kept","not_a_decision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/shadow/report":{"post":{"operationId":"postShadowReport","tags":["Decisioning"],"summary":"A report over comparisons you kept, for any period","description":"A report over comparisons you kept, for any period: agreement on outcome, the rules behind each difference, how far apart the figures were, the score beside your outcomes and what could not be read — each comparison’s seal checked first, and the report sealed.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/decisioning#post-v1-shadow-report"},"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"comparisons":{"description":"the comparisons as POST /v1/shadow returned them — up to 40000"},"from":{"description":"YYYY-MM-DD, optional"},"to":{"description":"YYYY-MM-DD, optional"}}}}}},"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"report":{"type":"object","properties":{"version":{"type":"string"},"period":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"days":{"type":"number"}},"required":["from","to","days"]},"count":{"type":"number"},"outcome":{"type":"object","properties":{"compared":{"type":"number"},"agree":{"type":"number"},"refer":{"type":"number"},"opposite":{"type":"number"},"notCompared":{"type":"number"},"agreement":{"type":"number"},"onFullEvidence":{"type":"object","properties":{"compared":{"type":"number"},"agree":{"type":"number"},"agreement":{"type":"number"}},"required":["compared","agree","agreement"]},"table":{"type":"object","properties":{"approved":{"type":"object","additionalProperties":{"type":"number"}},"declined":{"type":"object","additionalProperties":{"type":"number"}},"referred":{"type":"object","additionalProperties":{"type":"number"}},"withdrawn":{"type":"object","additionalProperties":{"type":"number"}}},"required":["approved","declined","referred","withdrawn"]}},"required":["compared","agree","refer","opposite","notCompared","agreement","onFullEvidence","table"]},"rules":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"kind":{"type":"string"},"condition":{"type":"string"},"times":{"type":"number"},"where":{"type":"object","additionalProperties":{"type":"number"}}},"required":["rule","kind","condition","times","where"]}},"reasons":{"type":"array"},"figures":{"type":"object","properties":{}},"score":{"type":"object","properties":{"approved":{"type":"object","properties":{"scored":{"type":"number"},"rating":{"type":"number"},"classes":{"type":"object","properties":{"BBB":{"type":"number"}},"required":["BBB"]}},"required":["scored","rating","classes"]}},"required":["approved"]},"amounts":{},"coverage":{"type":"object","properties":{"statementsRead":{"type":"number"},"statementsNotRead":{"type":"number"},"categorisedByMoney":{"type":"object","properties":{"median":{"type":"number"},"lowest":{"type":"number"}},"required":["median","lowest"]},"untested":{"type":"array"},"staff":{"type":"array"},"notApplicable":{"type":"array"},"notRead":{"type":"array","items":{"type":"object","properties":{"what":{"type":"string"},"times":{"type":"number"}},"required":["what","times"]}}},"required":["statementsRead","statementsNotRead","categorisedByMoney","untested","staff","notApplicable","notRead"]},"disagreements":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"on":{"type":"string"},"lender":{"type":"string"},"creditcrest":{"type":"string"},"match":{"type":"string"},"says":{"type":"string"}},"required":["reference","on","lender","creditcrest","match","says"]}},"comparisons":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"on":{"type":"string"},"hash":{"type":"string"}},"required":["reference","on","hash"]}},"refused":{"type":"array"},"says":{"type":"string"},"notADecision":{"type":"string"},"seal":{"type":"object","properties":{"alg":{"type":"string"},"over":{"type":"string"},"hash":{"type":"string"},"signed":{"type":"object","properties":{"alg":{"type":"string"},"by":{"type":"string"},"value":{"type":"string"}},"required":["alg","by","value"]}},"required":["alg","over","hash","signed"]}},"required":["version","period","count","outcome","rules","reasons","figures","score","amounts","coverage","disagreements","comparisons","refused","says","notADecision","seal"]},"not_a_decision":{"type":"string"}},"required":["report","not_a_decision"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}},"/v1/l/{tenant}/shadow":{"get":{"operationId":"getLTenantShadow","tags":["Decisioning"],"summary":"A shadow report over the comparisons kept in your own records service, for a period of up to 92 days","description":"A shadow report over the comparisons kept in your own records service, for a period of up to 92 days: agreement with your outcomes, the rules behind each difference, the figures, the score and what could not be read, sealed.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/reference/decisioning#get-v1-l-tenant-shadow"},"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"YYYY-MM-DD; 29 days before \"to\" if left out","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"YYYY-MM-DD; today in Sydney if left out","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object","properties":{"lender":{"type":"string"},"mode":{"type":"string"},"shadow":{"type":"boolean"},"kept":{"type":"string"},"report":{"type":"object","properties":{"version":{"type":"string"},"period":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"days":{"type":"number"}},"required":["from","to","days"]},"count":{"type":"number"},"outcome":{"type":"object","properties":{"compared":{"type":"number"},"agree":{"type":"number"},"refer":{"type":"number"},"opposite":{"type":"number"},"notCompared":{"type":"number"},"agreement":{"type":"number"},"onFullEvidence":{"type":"object","properties":{"compared":{"type":"number"},"agree":{"type":"number"},"agreement":{"type":"number"}},"required":["compared","agree","agreement"]},"table":{"type":"object","properties":{"approved":{"type":"object","additionalProperties":{"type":"number"}},"declined":{"type":"object","additionalProperties":{"type":"number"}},"referred":{"type":"object","additionalProperties":{"type":"number"}},"withdrawn":{"type":"object","additionalProperties":{"type":"number"}}},"required":["approved","declined","referred","withdrawn"]}},"required":["compared","agree","refer","opposite","notCompared","agreement","onFullEvidence","table"]},"rules":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"kind":{"type":"string"},"condition":{"type":"string"},"times":{"type":"number"},"where":{"type":"object","additionalProperties":{"type":"number"}}},"required":["rule","kind","condition","times","where"]}},"reasons":{"type":"array"},"figures":{"type":"object","properties":{}},"score":{"type":"object","properties":{"approved":{"type":"object","properties":{"scored":{"type":"number"},"rating":{"type":"number"},"classes":{"type":"object","properties":{"BB":{"type":"number"},"BBB":{"type":"number"}},"required":["BB"]}},"required":["scored","rating","classes"]}},"required":["approved"]},"amounts":{"type":"object","properties":{"compared":{"type":"number"},"suggestedLess":{"type":"number"},"suggestedMore":{"type":"number"},"difference":{"type":"object","properties":{"median":{"type":"number"},"p25":{"type":"number"},"p75":{"type":"number"}},"required":["median","p25","p75"]}},"required":["compared","suggestedLess","suggestedMore","difference"]},"coverage":{"type":"object","properties":{"statementsRead":{"type":"number"},"statementsNotRead":{"type":"number"},"categorisedByMoney":{"type":"object","properties":{"median":{"type":"number"},"lowest":{"type":"number"}},"required":["median","lowest"]},"untested":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"kind":{"type":"string"},"condition":{"type":"string"},"times":{"type":"number"},"why":{"type":"string"}},"required":["rule","kind","condition","times","why"]}},"staff":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"kind":{"type":"string"},"condition":{"type":"string"},"times":{"type":"number"}},"required":["rule","kind","condition","times"]}},"notApplicable":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"kind":{"type":"string"},"condition":{"type":"string"},"times":{"type":"number"},"why":{"type":"string"}},"required":["rule","kind","condition","times","why"]}},"notRead":{"type":"array","items":{"type":"object","properties":{"what":{"type":"string"},"times":{"type":"number"}},"required":["what","times"]}}},"required":["statementsRead","statementsNotRead","categorisedByMoney","untested","staff","notApplicable","notRead"]},"disagreements":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"on":{"type":"string"},"lender":{"type":"string"},"creditcrest":{"type":"string"},"match":{"type":"string"},"says":{"type":"string"}},"required":["reference","on","lender","creditcrest","match","says"]}},"comparisons":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"on":{"type":"string"},"hash":{"type":"string"}},"required":["reference","on","hash"]}},"refused":{"type":"array"},"says":{"type":"string"},"notADecision":{"type":"string"},"seal":{"type":"object","properties":{"alg":{"type":"string"},"over":{"type":"string"},"hash":{"type":"string"},"signed":{"type":"object","properties":{"alg":{"type":"string"},"by":{"type":"string"},"value":{"type":"string"}},"required":["alg","by","value"]}},"required":["alg","over","hash","signed"]}},"required":["version","period","count","outcome","rules","reasons","figures","score","amounts","coverage","disagreements","comparisons","refused","says","notADecision","seal"]}},"required":["lender","mode","shadow","kept","report"]}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"4XX":{"$ref":"#/components/responses/Refused"},"5XX":{"$ref":"#/components/responses/Failed"}},"security":[{"key":[]}]}}},"components":{"securitySchemes":{"key":{"type":"http","scheme":"bearer","description":"A Creditcrest key: cc_test_… for the sandbox (POST /v1/keys/sandbox), cc_live_… issued to a lender. Needed by every call that takes a body, and every call about a lender’s own records."},"admin":{"type":"http","scheme":"bearer","description":"Creditcrest’s own admin token, for its invoicing addresses. Not issued to lenders."}},"parameters":{"Idempotency-Key":{"name":"Idempotency-Key","in":"header","required":false,"description":"Any id of yours for this request, such as a UUID. Sent again with the same request within 24 hours, the call runs again and is counted once; with a different request, it is refused (409 idempotency_conflict). A call that was refused or failed does not use up its key.","schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{8,100}$"}}},"responses":{"Answer":{"description":"The answer, as JSON. Its fields are on the endpoint’s page of the reference.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Creditcrest-Version":{"$ref":"#/components/headers/Creditcrest-Version"}},"content":{"application/json":{"schema":{"type":"object"}}}},"Unauthenticated":{"description":"No key, or a key that is not valid.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The key may not make this call.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"RateLimited":{"description":"Too many calls this minute on this key.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Refused":{"description":"The request was refused. type says what to do, and the code’s entry in the error reference how.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Failed":{"description":"Creditcrest, or something it needed, did not answer. Retry with backoff.","headers":{"Request-Id":{"$ref":"#/components/headers/Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"headers":{"Request-Id":{"description":"Which request this was. Quote it to support.","schema":{"type":"string","pattern":"^req_[0-9a-f]{16}$"}},"Creditcrest-Version":{"description":"The API’s version: the date of the newest changelog entry.","schema":{"type":"string","format":"date"}},"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}},"Idempotent-Replayed":{"description":"true when this answer is to a request sent again with the same Idempotency-Key: it ran again, and is counted once.","schema":{"type":"string","enum":["true"]}},"RateLimit-Policy":{"description":"The key’s limit, as the IETF RateLimit headers draft writes it: \"live\";q=600;w=60 or \"test\";q=60;w=60.","schema":{"type":"string"}}},"schemas":{"Error":{"type":"object","required":["error","type","message","doc_url","request_id"],"description":"Every /v1 error, one shape. A product’s own refusal keeps its own fields beside these, such as ok: false.","properties":{"error":{"type":"string","description":"The code. Branch on it: it does not change.","examples":["key_required","invalid_key","expired_key","revoked_key","out_of_scope","wrong_lender","test_key","live_key","sandbox_only","rate_limited","keys_unavailable","unauthorised","bad_request","not_found","method_not_allowed","too_large","too_many","bad_day","bad_period","period_too_long","bad_month","no_applications","no_comparisons","refused","invalid","too_many_codes","texts_held","bad_idempotency_key","idempotency_conflict","conflict","policy_unreadable","policy_cannot_run","not_evidence","not_valid","not_signed","bad_name","bad_role","bad_email","not_on_list","not_open","shadow_mode","records_unreachable","no_session_secret","usage_unavailable","internal_error"]},"type":{"type":"string","enum":["invalid_request","authentication","permission","conflict","rate_limit","api_error","unavailable"],"description":"What to do, by status."},"message":{"type":"string","description":"For a person: what went wrong and what to send instead. Its words may change."},"param":{"type":"string","description":"The request field at fault, where the product knows which: amount, start.amount, or a query field."},"doc_url":{"type":"string","format":"uri","description":"The code’s entry in the error reference."},"request_id":{"type":"string","description":"The same as the Request-Id header."},"problems":{"type":"array","description":"Where more than one thing is wrong, each of them: a sentence, or an object with the field and a message.","items":{}},"ok":{"type":"boolean","const":false,"description":"On a product’s own refusal, as it always was."}}},"Detail":{"description":"What the words of a line settle under its category: which government payment, which kind of fee, which kind of lender. null where they settle none.","oneOf":[{"type":"object","title":"Government payment","required":["kind","code","label","act","social_security_act","matched"],"properties":{"kind":{"const":"benefit"},"code":{"enum":["pensioner_education_supplement","age_pension","disability_support_pension","carer_payment","carer_allowance","carer","parenting_payment","jobseeker_payment","youth_allowance","austudy","abstudy","special_benefit","mobility_allowance","crisis_payment","family_tax_benefit","parental_leave_pay","rent_assistance","veterans","ndis","centrelink_pension","unspecified"],"description":"Which payment. unspecified where the line names only the payer."},"label":{"type":"string","description":"The code, in words."},"matched":{"type":["string","null"],"description":"The words in the description that settled it."},"act":{"type":["string","null"],"description":"The Act it is paid under."},"social_security_act":{"type":["boolean","null"],"description":"Whether it is a social security payment under the Social Security Act 1991, the question reg 28HB(6) asks; null where the line does not settle it."}}},{"type":"object","title":"Fee","required":["kind","code","label","matched"],"properties":{"kind":{"const":"conduct"},"code":{"enum":["dishonour","overdrawn","late_payment"],"description":"A fee that says the account was short of money, or a repayment was late."},"label":{"type":"string","description":"The code, in words."},"matched":{"type":["string","null"],"description":"The words in the description that settled it."}}},{"type":"object","title":"Lender","required":["kind","code","label","matched"],"properties":{"kind":{"const":"lender"},"code":{"enum":["debt_collector","pay_advance","small_amount_lender"],"description":"What kind of lender a repayment or a loan received is with."},"label":{"type":"string","description":"The code, in words."},"matched":{"type":["string","null"],"description":"The words in the description that settled it."}}}]}}},"webhooks":{"application.submitted":{"post":{"operationId":"webhookApplicationSubmitted","summary":"An application was submitted, read and assessed, and is in the lender’s work queue","description":"An application was submitted, read and assessed, and is in the lender’s work queue. Made from case:<application> received. The detail: Your records: application:<application> and case:<application>. Your staff: /l/<lender>/operations/<application>.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/webhooks#application-submitted"},"parameters":[{"name":"Creditcrest-Signature","in":"header","required":true,"schema":{"type":"string"},"description":"t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<body>\">"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","object","type","version","created","livemode","lender","data","record"],"properties":{"id":{"type":"string","pattern":"^evt_[0-9a-f]{24}$"},"object":{"const":"event"},"type":{"const":"application.submitted"},"version":{"const":1},"created":{"type":"string","format":"date-time"},"livemode":{"type":"boolean"},"lender":{"type":"string"},"data":{"type":"object","properties":{"application":{"type":["string","null"],"description":"The application’s reference."},"customer":{"type":["string","null"],"description":"The customer’s id, the same on every application by the same person; null when the contacts were not proved, so no customer was matched or made."},"product":{"type":["string","null"],"description":"The product’s key in your configuration."},"channel":{"enum":["web","api",null],"description":"web: your hosted application pages; api: your own program, POST /v1/l/<lender>/applications."}},"required":["application","customer","product","channel"]},"record":{"type":["object","null"],"properties":{"stream":{"type":"string"},"seq":{"type":"integer"},"hash":{"type":"string"}}}}},"example":{"id":"evt_3f9a1c2e7b4d5a6f8e0c1b2a","object":"event","type":"application.submitted","version":1,"created":"2026-10-19T02:00:00.000Z","livemode":false,"lender":"example-lending","data":{"application":"EX-A-20261015-4F7K2Q9C1D","customer":"C-7QK2M4XR9T","product":"sacc","channel":"web"},"record":{"stream":"case:EX-A-20261015-4F7K2Q9C1D","seq":7,"hash":"5b1e9d0c3a7f2e4b6c8d0a1f3e5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d5e7f9a1b"}}}}},"responses":{"200":{"description":"Any 2xx, within 10 seconds: received. Anything else is a failed attempt; a notice is tried at once, then after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, then every 10 to 12 hours, for 72 hours."}}}},"application.decided":{"post":{"operationId":"webhookApplicationDecided","summary":"A person at the lender concluded on an application, and the conclusion stands: recorded, or confirmed by a second person where the lender requires one","description":"A person at the lender concluded on an application, and the conclusion stands: recorded, or confirmed by a second person where the lender requires one. Made from case:<application> concluded (without a second check), or confirmed. The detail: Your records: case:<application> (the conclusion, its rationale and its sealed record).","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/webhooks#application-decided"},"parameters":[{"name":"Creditcrest-Signature","in":"header","required":true,"schema":{"type":"string"},"description":"t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<body>\">"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","object","type","version","created","livemode","lender","data","record"],"properties":{"id":{"type":"string","pattern":"^evt_[0-9a-f]{24}$"},"object":{"const":"event"},"type":{"const":"application.decided"},"version":{"const":1},"created":{"type":"string","format":"date-time"},"livemode":{"type":"boolean"},"lender":{"type":"string"},"data":{"type":"object","properties":{"application":{"type":["string","null"],"description":"The application’s reference."},"outcome":{"enum":["not_unsuitable","unsuitable","more_information","withdrawn","not_proceeding",null],"description":"The conclusion a person recorded: not_unsuitable, unsuitable, more_information, withdrawn or not_proceeding. Creditcrest never decides."},"reasonCode":{"type":["string","null"],"description":"Your own reason code the person chose."},"secondCheck":{"type":["boolean","null"],"description":"Whether a second person confirmed it."},"loan":{"type":["string","null"],"description":"The loan reference a contract for it will carry, when the outcome is not_unsuitable; otherwise null."}},"required":["application","outcome","reasonCode","secondCheck","loan"]},"record":{"type":["object","null"],"properties":{"stream":{"type":"string"},"seq":{"type":"integer"},"hash":{"type":"string"}}}}},"example":{"id":"evt_3f9a1c2e7b4d5a6f8e0c1b2a","object":"event","type":"application.decided","version":1,"created":"2026-10-19T02:00:00.000Z","livemode":false,"lender":"example-lending","data":{"application":"EX-A-20261015-4F7K2Q9C1D","outcome":"not_unsuitable","reasonCode":"NU-01","secondCheck":false,"loan":"LN-A-20261015-4F7K2Q9C1D"},"record":{"stream":"requests:LN-A-20261015-4F7K2Q9C1D","seq":7,"hash":"5b1e9d0c3a7f2e4b6c8d0a1f3e5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d5e7f9a1b"}}}}},"responses":{"200":{"description":"Any 2xx, within 10 seconds: received. Anything else is a failed attempt; a notice is tried at once, then after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, then every 10 to 12 hours, for 72 hours."}}}},"application.withdrawn":{"post":{"operationId":"webhookApplicationWithdrawn","summary":"An application will go no further: the applicant carried on with another one, or the lender’s staff closed the file as withdrawn","description":"An application will go no further: the applicant carried on with another one, or the lender’s staff closed the file as withdrawn. Made from application:<application> withdrawn, or case:<application> moved to withdrawn. The detail: Your records: application:<application> or case:<application>.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/webhooks#application-withdrawn"},"parameters":[{"name":"Creditcrest-Signature","in":"header","required":true,"schema":{"type":"string"},"description":"t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<body>\">"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","object","type","version","created","livemode","lender","data","record"],"properties":{"id":{"type":"string","pattern":"^evt_[0-9a-f]{24}$"},"object":{"const":"event"},"type":{"const":"application.withdrawn"},"version":{"const":1},"created":{"type":"string","format":"date-time"},"livemode":{"type":"boolean"},"lender":{"type":"string"},"data":{"type":"object","properties":{"application":{"type":["string","null"],"description":"The application’s reference."},"by":{"enum":["applicant","lender",null],"description":"Who withdrew it."}},"required":["application","by"]},"record":{"type":["object","null"],"properties":{"stream":{"type":"string"},"seq":{"type":"integer"},"hash":{"type":"string"}}}}},"example":{"id":"evt_3f9a1c2e7b4d5a6f8e0c1b2a","object":"event","type":"application.withdrawn","version":1,"created":"2026-10-19T02:00:00.000Z","livemode":false,"lender":"example-lending","data":{"application":"EX-A-20261015-4F7K2Q9C1D","by":"lender"},"record":{"stream":"case:EX-A-20261015-4F7K2Q9C1D","seq":7,"hash":"5b1e9d0c3a7f2e4b6c8d0a1f3e5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d5e7f9a1b"}}}}},"responses":{"200":{"description":"Any 2xx, within 10 seconds: received. Anything else is a failed attempt; a notice is tried at once, then after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, then every 10 to 12 hours, for 72 hours."}}}},"contract.signed":{"post":{"operationId":"webhookContractSigned","summary":"The borrower signed the contract","description":"The borrower signed the contract. Made from contract:<loan> signed. The detail: Your records: contract:<loan>, and the contract document <loan> with its signed copy.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/webhooks#contract-signed"},"parameters":[{"name":"Creditcrest-Signature","in":"header","required":true,"schema":{"type":"string"},"description":"t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<body>\">"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","object","type","version","created","livemode","lender","data","record"],"properties":{"id":{"type":"string","pattern":"^evt_[0-9a-f]{24}$"},"object":{"const":"event"},"type":{"const":"contract.signed"},"version":{"const":1},"created":{"type":"string","format":"date-time"},"livemode":{"type":"boolean"},"lender":{"type":"string"},"data":{"type":"object","properties":{"loan":{"type":["string","null"],"description":"The loan’s reference: LN- and the application reference without its prefix."},"on":{"type":["string","null"],"description":"The day it was signed, in Sydney."},"documentHash":{"type":["string","null"],"description":"The SHA-256 of the contract as it was signed, to check against the copy you keep."}},"required":["loan","on","documentHash"]},"record":{"type":["object","null"],"properties":{"stream":{"type":"string"},"seq":{"type":"integer"},"hash":{"type":"string"}}}}},"example":{"id":"evt_3f9a1c2e7b4d5a6f8e0c1b2a","object":"event","type":"contract.signed","version":1,"created":"2026-10-19T02:00:00.000Z","livemode":false,"lender":"example-lending","data":{"loan":"LN-A-20261015-4F7K2Q9C1D","on":"2026-10-16","documentHash":"9f2c4e1b7a3d5c6e8f0a1b2c3d4e5f60718293a4b5c6d7e8f9a0b1c2d3e4f5a6"},"record":{"stream":"contract:LN-A-20261015-4F7K2Q9C1D","seq":7,"hash":"5b1e9d0c3a7f2e4b6c8d0a1f3e5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d5e7f9a1b"}}}}},"responses":{"200":{"description":"Any 2xx, within 10 seconds: received. Anything else is a failed attempt; a notice is tried at once, then after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, then every 10 to 12 hours, for 72 hours."}}}},"loan.funded":{"post":{"operationId":"webhookLoanFunded","summary":"The advance settled, and the contract is funded","description":"The advance settled, and the contract is funded. Made from contract:<loan> funded. The detail: GET /v1/l/<lender>/loans/<loan>.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/webhooks#loan-funded"},"parameters":[{"name":"Creditcrest-Signature","in":"header","required":true,"schema":{"type":"string"},"description":"t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<body>\">"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","object","type","version","created","livemode","lender","data","record"],"properties":{"id":{"type":"string","pattern":"^evt_[0-9a-f]{24}$"},"object":{"const":"event"},"type":{"const":"loan.funded"},"version":{"const":1},"created":{"type":"string","format":"date-time"},"livemode":{"type":"boolean"},"lender":{"type":"string"},"data":{"type":"object","properties":{"loan":{"type":["string","null"],"description":"The loan’s reference: LN- and the application reference without its prefix."},"on":{"type":["string","null"],"description":"The day the money settled."},"recordedBy":{"enum":["provider","staff",null],"description":"provider: the payment provider’s report; staff: a senior analyst recorded a settlement they saw."}},"required":["loan","on","recordedBy"]},"record":{"type":["object","null"],"properties":{"stream":{"type":"string"},"seq":{"type":"integer"},"hash":{"type":"string"}}}}},"example":{"id":"evt_3f9a1c2e7b4d5a6f8e0c1b2a","object":"event","type":"loan.funded","version":1,"created":"2026-10-19T02:00:00.000Z","livemode":false,"lender":"example-lending","data":{"loan":"LN-A-20261015-4F7K2Q9C1D","on":"2026-10-19","recordedBy":"provider"},"record":{"stream":"contract:LN-A-20261015-4F7K2Q9C1D","seq":7,"hash":"5b1e9d0c3a7f2e4b6c8d0a1f3e5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d5e7f9a1b"}}}}},"responses":{"200":{"description":"Any 2xx, within 10 seconds: received. Anything else is a failed attempt; a notice is tried at once, then after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, then every 10 to 12 hours, for 72 hours."}}}},"repayment.collected":{"post":{"operationId":"webhookRepaymentCollected","summary":"A payment was put on a loan’s account","description":"A payment was put on a loan’s account. Made from account:<loan> payment. The detail: GET /v1/l/<lender>/loans/<loan> (the ledger and the balance).","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/webhooks#repayment-collected"},"parameters":[{"name":"Creditcrest-Signature","in":"header","required":true,"schema":{"type":"string"},"description":"t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<body>\">"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","object","type","version","created","livemode","lender","data","record"],"properties":{"id":{"type":"string","pattern":"^evt_[0-9a-f]{24}$"},"object":{"const":"event"},"type":{"const":"repayment.collected"},"version":{"const":1},"created":{"type":"string","format":"date-time"},"livemode":{"type":"boolean"},"lender":{"type":"string"},"data":{"type":"object","properties":{"loan":{"type":["string","null"],"description":"The loan’s reference: LN- and the application reference without its prefix."},"payment":{"type":["string","null"],"description":"The payment’s id on the account."},"on":{"type":["string","null"],"description":"The day it was paid."},"via":{"enum":["payto","request","staff","other",null],"description":"payto: a PayTo debit the provider reported settled; request: a payment the borrower asked for, settled; staff: recorded on the loan’s page; other: anything else."}},"required":["loan","payment","on","via"]},"record":{"type":["object","null"],"properties":{"stream":{"type":"string"},"seq":{"type":"integer"},"hash":{"type":"string"}}}}},"example":{"id":"evt_3f9a1c2e7b4d5a6f8e0c1b2a","object":"event","type":"repayment.collected","version":1,"created":"2026-10-19T02:00:00.000Z","livemode":false,"lender":"example-lending","data":{"loan":"LN-A-20261015-4F7K2Q9C1D","payment":"payto-example-lending.7Q2M4XR9TK3B8W1Z","on":"2026-10-29","via":"payto"},"record":{"stream":"account:LN-A-20261015-4F7K2Q9C1D","seq":7,"hash":"5b1e9d0c3a7f2e4b6c8d0a1f3e5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d5e7f9a1b"}}}}},"responses":{"200":{"description":"Any 2xx, within 10 seconds: received. Anything else is a failed attempt; a notice is tried at once, then after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, then every 10 to 12 hours, for 72 hours."}}}},"repayment.failed":{"post":{"operationId":"webhookRepaymentFailed","summary":"A repayment did not arrive: a payment already on the account was reversed (a dishonour), or a PayTo debit failed before it was paid","description":"A repayment did not arrive: a payment already on the account was reversed (a dishonour), or a PayTo debit failed before it was paid. Made from account:<loan> reversal, or payments:<loan> payment outcome (a debit, failed). The detail: GET /v1/l/<lender>/loans/<loan>; your records: account:<loan> and payments:<loan>.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/webhooks#repayment-failed"},"parameters":[{"name":"Creditcrest-Signature","in":"header","required":true,"schema":{"type":"string"},"description":"t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<body>\">"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","object","type","version","created","livemode","lender","data","record"],"properties":{"id":{"type":"string","pattern":"^evt_[0-9a-f]{24}$"},"object":{"const":"event"},"type":{"const":"repayment.failed"},"version":{"const":1},"created":{"type":"string","format":"date-time"},"livemode":{"type":"boolean"},"lender":{"type":"string"},"data":{"type":"object","properties":{"loan":{"type":["string","null"],"description":"The loan’s reference: LN- and the application reference without its prefix."},"on":{"type":["string","null"],"description":"The day it was reported."},"failure":{"enum":["reversed","debit_failed",null],"description":"reversed: a payment on the account came back; debit_failed: a debit was refused and never paid."},"payment":{"type":["string","null"],"description":"The payment reversed, when one was on the account; otherwise null."},"instruction":{"type":["string","null"],"description":"The debit instruction, for a PayTo debit; otherwise null."}},"required":["loan","on","failure","payment","instruction"]},"record":{"type":["object","null"],"properties":{"stream":{"type":"string"},"seq":{"type":"integer"},"hash":{"type":"string"}}}}},"example":{"id":"evt_3f9a1c2e7b4d5a6f8e0c1b2a","object":"event","type":"repayment.failed","version":1,"created":"2026-10-19T02:00:00.000Z","livemode":false,"lender":"example-lending","data":{"loan":"LN-A-20261015-4F7K2Q9C1D","on":"2026-11-12","failure":"reversed","payment":"lm-payment-4","instruction":null},"record":{"stream":"account:LN-A-20261015-4F7K2Q9C1D","seq":7,"hash":"5b1e9d0c3a7f2e4b6c8d0a1f3e5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d5e7f9a1b"}}}}},"responses":{"200":{"description":"Any 2xx, within 10 seconds: received. Anything else is a failed attempt; a notice is tried at once, then after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, then every 10 to 12 hours, for 72 hours."}}}},"hardship.requested":{"post":{"operationId":"webhookHardshipRequested","summary":"A borrower asked for hardship help","description":"A borrower asked for hardship help. The clock to answer it starts on the day received. Hardship is never default: no event says so. Made from requests:<loan> hardship notice, or support:<notice> hardship notice. The detail: GET /v1/l/<lender>/requests/<loan>, or GET /v1/l/<lender>/support/<notice> for one given on the support page.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/webhooks#hardship-requested"},"parameters":[{"name":"Creditcrest-Signature","in":"header","required":true,"schema":{"type":"string"},"description":"t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<body>\">"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","object","type","version","created","livemode","lender","data","record"],"properties":{"id":{"type":"string","pattern":"^evt_[0-9a-f]{24}$"},"object":{"const":"event"},"type":{"const":"hardship.requested"},"version":{"const":1},"created":{"type":"string","format":"date-time"},"livemode":{"type":"boolean"},"lender":{"type":"string"},"data":{"type":"object","properties":{"notice":{"type":["string","null"],"description":"The notice’s acknowledgement reference (H-…)."},"loan":{"type":["string","null"],"description":"The loan, when the borrower was signed in or staff recorded it; null for the support page, where the loan is only what somebody typed."},"channel":{"enum":["phone","in_person","online_form","email","letter","sms","other",null],"description":"How it was given."},"receivedOn":{"type":["string","null"],"description":"The day it was received."},"via":{"enum":["account","staff","support_page",null],"description":"Where it was recorded."}},"required":["notice","loan","channel","receivedOn","via"]},"record":{"type":["object","null"],"properties":{"stream":{"type":"string"},"seq":{"type":"integer"},"hash":{"type":"string"}}}}},"example":{"id":"evt_3f9a1c2e7b4d5a6f8e0c1b2a","object":"event","type":"hardship.requested","version":1,"created":"2026-10-19T02:00:00.000Z","livemode":false,"lender":"example-lending","data":{"notice":"H-261020-ABCDEF","loan":"LN-A-20261015-4F7K2Q9C1D","channel":"online_form","receivedOn":"2026-10-20","via":"account"},"record":{"stream":"requests:LN-A-20261015-4F7K2Q9C1D","seq":7,"hash":"5b1e9d0c3a7f2e4b6c8d0a1f3e5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d5e7f9a1b"}}}}},"responses":{"200":{"description":"Any 2xx, within 10 seconds: received. Anything else is a failed attempt; a notice is tried at once, then after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, then every 10 to 12 hours, for 72 hours."}}}},"hardship.arranged":{"post":{"operationId":"webhookHardshipArranged","summary":"A hardship arrangement started on a loan","description":"A hardship arrangement started on a loan. While it runs, days past due are held and no fee is charged. Made from account:<loan> hardship-start. The detail: GET /v1/l/<lender>/loans/<loan> (the arrangement and its plan).","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/webhooks#hardship-arranged"},"parameters":[{"name":"Creditcrest-Signature","in":"header","required":true,"schema":{"type":"string"},"description":"t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<body>\">"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","object","type","version","created","livemode","lender","data","record"],"properties":{"id":{"type":"string","pattern":"^evt_[0-9a-f]{24}$"},"object":{"const":"event"},"type":{"const":"hardship.arranged"},"version":{"const":1},"created":{"type":"string","format":"date-time"},"livemode":{"type":"boolean"},"lender":{"type":"string"},"data":{"type":"object","properties":{"loan":{"type":["string","null"],"description":"The loan’s reference: LN- and the application reference without its prefix."},"arrangement":{"type":["string","null"],"description":"The arrangement’s id on the account."},"notice":{"type":["string","null"],"description":"The notice it answers, when it names one."},"from":{"type":["string","null"],"description":"The day it starts."},"until":{"type":["string","null"],"description":"The day it ends, when it has one."}},"required":["loan","arrangement","notice","from","until"]},"record":{"type":["object","null"],"properties":{"stream":{"type":"string"},"seq":{"type":"integer"},"hash":{"type":"string"}}}}},"example":{"id":"evt_3f9a1c2e7b4d5a6f8e0c1b2a","object":"event","type":"hardship.arranged","version":1,"created":"2026-10-19T02:00:00.000Z","livemode":false,"lender":"example-lending","data":{"loan":"LN-A-20261015-4F7K2Q9C1D","arrangement":"lm-arrangement-7","notice":"H-261020-ABCDEF","from":"2026-10-22","until":"2027-01-31"},"record":{"stream":"account:LN-A-20261015-4F7K2Q9C1D","seq":7,"hash":"5b1e9d0c3a7f2e4b6c8d0a1f3e5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d5e7f9a1b"}}}}},"responses":{"200":{"description":"Any 2xx, within 10 seconds: received. Anything else is a failed attempt; a notice is tried at once, then after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, then every 10 to 12 hours, for 72 hours."}}}},"complaint.received":{"post":{"operationId":"webhookComplaintReceived","summary":"A complaint was received","description":"A complaint was received. Its clock starts on the day received. Made from requests:<loan> complaint received, or support:<complaint> complaint received. The detail: GET /v1/l/<lender>/requests/<loan>, or GET /v1/l/<lender>/support/<complaint>.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/webhooks#complaint-received"},"parameters":[{"name":"Creditcrest-Signature","in":"header","required":true,"schema":{"type":"string"},"description":"t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<body>\">"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","object","type","version","created","livemode","lender","data","record"],"properties":{"id":{"type":"string","pattern":"^evt_[0-9a-f]{24}$"},"object":{"const":"event"},"type":{"const":"complaint.received"},"version":{"const":1},"created":{"type":"string","format":"date-time"},"livemode":{"type":"boolean"},"lender":{"type":"string"},"data":{"type":"object","properties":{"complaint":{"type":["string","null"],"description":"The complaint’s acknowledgement reference (C-…)."},"loan":{"type":["string","null"],"description":"The loan, when the borrower was signed in; otherwise null."},"kind":{"enum":["standard","hardship",null],"description":"hardship: about hardship help, which has a shorter time to answer."},"category":{"type":["string","null"],"description":"What the person said it is about: fees, payments, hardship, service, privacy, other, or uncategorised (the account’s and the support page’s own list)."},"channel":{"enum":["phone","in_person","online_form","email","letter","sms","other",null],"description":"How it was given."},"receivedOn":{"type":["string","null"],"description":"The day it was received."},"via":{"enum":["account","support_page",null],"description":"Where it was recorded."}},"required":["complaint","loan","kind","category","channel","receivedOn","via"]},"record":{"type":["object","null"],"properties":{"stream":{"type":"string"},"seq":{"type":"integer"},"hash":{"type":"string"}}}}},"example":{"id":"evt_3f9a1c2e7b4d5a6f8e0c1b2a","object":"event","type":"complaint.received","version":1,"created":"2026-10-19T02:00:00.000Z","livemode":false,"lender":"example-lending","data":{"complaint":"C-261020-ABCDEF","loan":null,"kind":"standard","category":"fees","channel":"online_form","receivedOn":"2026-10-20","via":"support_page"},"record":{"stream":"support:C-261020-ABCDEF","seq":7,"hash":"5b1e9d0c3a7f2e4b6c8d0a1f3e5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d5e7f9a1b"}}}}},"responses":{"200":{"description":"Any 2xx, within 10 seconds: received. Anything else is a failed attempt; a notice is tried at once, then after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, then every 10 to 12 hours, for 72 hours."}}}},"daily_run.completed":{"post":{"operationId":"webhookDailyRunCompleted","summary":"The daily run Creditcrest runs for the lender finished a day: the day before sealed, what is due today listed and held","description":"The daily run Creditcrest runs for the lender finished a day: the day before sealed, what is due today listed and held. Only for a lender whose configuration has Creditcrest run its day. Made from daily-run:<day> daily run. The detail: Your records: daily-run:<day> (every debit due and held, by loan).","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/webhooks#daily-run-completed"},"parameters":[{"name":"Creditcrest-Signature","in":"header","required":true,"schema":{"type":"string"},"description":"t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<body>\">"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","object","type","version","created","livemode","lender","data","record"],"properties":{"id":{"type":"string","pattern":"^evt_[0-9a-f]{24}$"},"object":{"const":"event"},"type":{"const":"daily_run.completed"},"version":{"const":1},"created":{"type":"string","format":"date-time"},"livemode":{"type":"boolean"},"lender":{"type":"string"},"data":{"type":"object","properties":{"day":{"type":["string","null"],"description":"The day run, in Sydney."},"trigger":{"enum":["schedule","watch",null],"description":"schedule: 6am Sydney; watch: the ten-minute watch, catching a day up."},"accounts":{"type":["integer","null"],"description":"Accounts read."},"sealed":{"type":["integer","null"],"description":"Accounts whose day was sealed."},"debitsDue":{"type":["integer","null"],"description":"Debits due today."},"debitsHeld":{"type":["integer","null"],"description":"Debits held, each with its reason in the record."},"overdue":{"type":["integer","null"],"description":"Deadlines overdue: hardship, complaints, payout statements."},"dueToday":{"type":["integer","null"],"description":"Deadlines due today."},"messagesDue":{"type":["integer","null"],"description":"Messages due."},"problems":{"type":["integer","null"],"description":"Problems the run met."},"paymentsPaused":{"type":["boolean","null"],"description":"Whether Creditcrest’s pause on money movement was on."}},"required":["day","trigger","accounts","sealed","debitsDue","debitsHeld","overdue","dueToday","messagesDue","problems","paymentsPaused"]},"record":{"type":["object","null"],"properties":{"stream":{"type":"string"},"seq":{"type":"integer"},"hash":{"type":"string"}}}}},"example":{"id":"evt_3f9a1c2e7b4d5a6f8e0c1b2a","object":"event","type":"daily_run.completed","version":1,"created":"2026-10-19T02:00:00.000Z","livemode":false,"lender":"example-lending","data":{"day":"2026-10-20","trigger":"schedule","accounts":42,"sealed":42,"debitsDue":3,"debitsHeld":1,"overdue":0,"dueToday":2,"messagesDue":5,"problems":0,"paymentsPaused":false},"record":{"stream":"daily-run:2026-10-20","seq":7,"hash":"5b1e9d0c3a7f2e4b6c8d0a1f3e5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d5e7f9a1b"}}}}},"responses":{"200":{"description":"Any 2xx, within 10 seconds: received. Anything else is a failed attempt; a notice is tried at once, then after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, then every 10 to 12 hours, for 72 hours."}}}},"webhook.test":{"post":{"operationId":"webhookWebhookTest","summary":"A test, sent from the Webhooks page of the lender’s console","description":"A test, sent from the Webhooks page of the lender’s console. It means nothing else: answer 2xx. Made from the console’s “Send a test event”. The detail: Nothing to read.","externalDocs":{"url":"https://app.creditcresttechnologies.com.au/developers/webhooks#webhook-test"},"parameters":[{"name":"Creditcrest-Signature","in":"header","required":true,"schema":{"type":"string"},"description":"t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<body>\">"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","object","type","version","created","livemode","lender","data","record"],"properties":{"id":{"type":"string","pattern":"^evt_[0-9a-f]{24}$"},"object":{"const":"event"},"type":{"const":"webhook.test"},"version":{"const":1},"created":{"type":"string","format":"date-time"},"livemode":{"type":"boolean"},"lender":{"type":"string"},"data":{"type":"object","properties":{"requestedBy":{"enum":["admin",null],"description":"Who sent it: an operations admin."}},"required":["requestedBy"]},"record":{"type":["object","null"],"properties":{"stream":{"type":"string"},"seq":{"type":"integer"},"hash":{"type":"string"}}}}},"example":{"id":"evt_3f9a1c2e7b4d5a6f8e0c1b2a","object":"event","type":"webhook.test","version":1,"created":"2026-10-19T02:00:00.000Z","livemode":false,"lender":"example-lending","data":{"requestedBy":"admin"},"record":null}}}},"responses":{"200":{"description":"Any 2xx, within 10 seconds: received. Anything else is a failed attempt; a notice is tried at once, then after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, then every 10 to 12 hours, for 72 hours."}}}}}}