# Creditcrest API

> Lending software for Australian credit providers, as an HTTP API: JSON in, evidence out, nothing kept. Base URL https://app.creditcresttechnologies.com.au. Version 2026-10-22 (the newest changelog entry).

A call that takes a body needs a key: "Authorization: Bearer <key>". A sandbox key is one call, POST /v1/keys/sandbox, and begins cc_test_; a live key begins cc_live_. Every answer carries a Request-Id header. Every /v1 error is JSON: error (the code), type, message, doc_url and request_id.

## Docs

- [Quickstart](https://app.creditcresttechnologies.com.au/developers/quickstart): a sandbox key, a bank statement read, and a loan tested against it, in four calls
- [Authentication](https://app.creditcresttechnologies.com.au/developers/authentication): sandbox and live keys, limits, and the headers on every answer
- [Errors](https://app.creditcresttechnologies.com.au/developers/errors): the error envelope, its types, retrying safely, and every code
- [Assess from a bank statement](https://app.creditcresttechnologies.com.au/developers/guides/assess-from-a-statement): Enough history, a reading, and what it can service.
- [Cost, run and collect a small loan](https://app.creditcresttechnologies.com.au/developers/guides/run-a-small-loan): A small amount contract from its fees to a hardship notice.
- [Changelog](https://app.creditcresttechnologies.com.au/developers/changelog): every change to /v1, newest first
- [OpenAPI 3.1](https://app.creditcresttechnologies.com.au/openapi.json): every endpoint, as data

## Broker

- [GET /v1/broker](https://app.creditcresttechnologies.com.au/developers/reference/broker#get-v1-broker): The best interests file for the query below, as data: every option costed, what the file still needs, and its seal.
- [GET /v1/broker/fields](https://app.creditcresttechnologies.com.au/developers/reference/broker#get-v1-broker-fields): This description: every field the file takes.

## Compare

- [GET /v1/back-book](https://app.creditcresttechnologies.com.au/developers/reference/compare#get-v1-back-book): 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.
- [GET /v1/compare](https://app.creditcresttechnologies.com.au/developers/reference/compare#get-v1-compare): Rank the products in the dataset for one loan.
- [GET /v1/dataset](https://app.creditcresttechnologies.com.au/developers/reference/compare#get-v1-dataset): What was read, from whom, and when.

## Small Amount

- [GET /v1/small-amount](https://app.creditcresttechnologies.com.au/developers/reference/smallamount#get-v1-small-amount): The same costing, as data.
- [GET /v1/small-amount/provisions](https://app.creditcresttechnologies.com.au/developers/reference/smallamount#get-v1-small-amount-provisions): The provisions, as data.

## LoanManager

- [GET /v1/loanmanager](https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#get-v1-loanmanager): The account from the page’s own query fields, as data
- [POST /v1/loanmanager/application](https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#post-v1-loanmanager-application) (key): The application against the product version and form published on that day
- [POST /v1/loanmanager/contract](https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#post-v1-loanmanager-contract) (key): Where a contract stands, from prepared to funded
- [GET /v1/loanmanager/assessment-copy](https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#get-v1-loanmanager-assessment-copy): When the consumer’s copy of the assessment is due under s 132
- [POST /v1/loanmanager/account](https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#post-v1-loanmanager-account) (key): One loan replayed from its terms and what happened to it
- [GET /v1/l](https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#get-v1-l): 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.
- [GET /v1/l/:tenant/loans](https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#get-v1-l-tenant-loans) (key): 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.
- [GET /v1/l/:tenant/loans/:loanRef](https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#get-v1-l-tenant-loans-loanref) (key): 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.
- [GET /v1/l/:tenant/requests/:loanRef](https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#get-v1-l-tenant-requests-loanref) (key): What a borrower asked for on a loan: payments with their state (processing, settled or returned), hardship notices, complaints and payout statements.
- [GET /v1/l/:tenant/support/:reference](https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#get-v1-l-tenant-support-reference) (key): 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.
- [POST /v1/l/:tenant/requests/:loanRef/settle](https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#post-v1-l-tenant-requests-loanref-settle) (key): Settle or return a payment a borrower asked for.
- [POST /v1/l/:tenant/day](https://app.creditcresttechnologies.com.au/developers/reference/loanmanager#post-v1-l-tenant-day) (key): 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.

## Operations

- [GET /v1/operations](https://app.creditcresttechnologies.com.au/developers/reference/operations#get-v1-operations): Describes this API: what it takes and what it returns.
- [POST /v1/operations/case](https://app.creditcresttechnologies.com.au/developers/reference/operations#post-v1-operations-case) (key): The file replayed
- [POST /v1/operations/queue](https://app.creditcresttechnologies.com.au/developers/reference/operations#post-v1-operations-queue) (key): The queue, in the order to pick files up
- [POST /v1/l/:tenant/staff-sessions](https://app.creditcresttechnologies.com.au/developers/reference/operations#post-v1-l-tenant-staff-sessions) (key): A sign-in link to the lender’s operations console for one of its staff, lasting ten minutes and working once.

## Compliance

- [GET /v1/compliance](https://app.creditcresttechnologies.com.au/developers/reference/compliance#get-v1-compliance): Describes this API: what it takes and what it returns.
- [POST /v1/compliance/readiness](https://app.creditcresttechnologies.com.au/developers/reference/compliance#post-v1-compliance-readiness) (key): {gates: [{key, status, attestedBy, attestedOn, evidence, expiresOn, mandatory}], asAt, environment?, required?}
- [POST /v1/compliance/capabilities](https://app.creditcresttechnologies.com.au/developers/reference/compliance#post-v1-compliance-capabilities) (key): Shadow on turns off everything but keeping records
- [POST /v1/compliance/changes](https://app.creditcresttechnologies.com.au/developers/reference/compliance#post-v1-compliance-changes) (key): {requests: [{id, control, change, requestedBy, approvedBy, approvedOn, rejectedBy}], approvers: [...]}
- [POST /v1/compliance/target-market](https://app.creditcresttechnologies.com.au/developers/reference/compliance#post-v1-compliance-target-market) (key): {tmd: {criteria, channels, reviewEveryDays, triggers}, facts, channel, asAt, metrics}
- [POST /v1/compliance/traceability](https://app.creditcresttechnologies.com.au/developers/reference/compliance#post-v1-compliance-traceability) (key): {matrix: {obligations, controls, tests, evidence}, asAt}

## Portal

- [GET /v1/portal](https://app.creditcresttechnologies.com.au/developers/reference/portal#get-v1-portal): Describes this API: what it takes and what it returns.
- [POST /v1/portal/account](https://app.creditcresttechnologies.com.au/developers/reference/portal#post-v1-portal-account) (key): The borrower’s view of their account, from the ledger
- [POST /v1/portal/render](https://app.creditcresttechnologies.com.au/developers/reference/portal#post-v1-portal-render) (key): A message, rendered, or why not
- [POST /v1/portal/may-contact](https://app.creditcresttechnologies.com.au/developers/reference/portal#post-v1-portal-may-contact) (key): {purpose, channel, offersSmallAmountCredit, requestedByConsumer, recipient, recentSends, frequencyCap, journeyOver, onDay}

## Book and reports

- [GET /v1/growth](https://app.creditcresttechnologies.com.au/developers/reference/growth#get-v1-growth): Describes this API: what it takes and what it returns.
- [POST /v1/growth/check-event](https://app.creditcresttechnologies.com.au/developers/reference/growth#post-v1-growth-check-event) (key): The problems with an event, if any
- [POST /v1/growth/funnel](https://app.creditcresttechnologies.com.au/developers/reference/growth#post-v1-growth-funnel) (key): The funnel in people, and cost per funded loan
- [POST /v1/growth/experiment](https://app.creditcresttechnologies.com.au/developers/reference/growth#post-v1-growth-experiment) (key): Whether it may run
- [POST /v1/growth/guardrails](https://app.creditcresttechnologies.com.au/developers/reference/growth#post-v1-growth-guardrails) (key): Whether growth pauses
- [POST /v1/loanmanager/book](https://app.creditcresttechnologies.com.au/developers/reference/growth#post-v1-loanmanager-book) (key): The book added up on a day
- [GET /v1/l/:tenant/book/funder](https://app.creditcresttechnologies.com.au/developers/reference/growth#get-v1-l-tenant-book-funder) (key): The funder pack for a lender whose records Creditcrest keeps: loan tape, borrowing base, vintage curves, roll rates, complaints and refunds.

## Intent

- [GET /v1/intent](https://app.creditcresttechnologies.com.au/developers/reference/intent#get-v1-intent): Describes this API: what it takes and what it returns.
- [POST /v1/intent/read](https://app.creditcresttechnologies.com.au/developers/reference/intent#post-v1-intent-read) (key): {accounts: [{terms, events, asAt}], conduct, reading?, declared?
- [POST /v1/intent/calibrate](https://app.creditcresttechnologies.com.au/developers/reference/intent#post-v1-intent-calibrate) (key): {outcomes: [{index, outcome}]}

## Statement

- [GET /v1/evidence](https://app.creditcresttechnologies.com.au/developers/reference/statement#get-v1-evidence): Describes this API: what it takes and what it returns.
- [POST /v1/evidence/coverage](https://app.creditcresttechnologies.com.au/developers/reference/statement#post-v1-evidence-coverage) (key): {product, accounts: [{id, role, from, to}], applicationDay, selfEmployed?, refinancing?, policy?}
- [GET /v1/statement](https://app.creditcresttechnologies.com.au/developers/reference/statement#get-v1-statement): Describes this API: what it takes and what it returns.
- [POST /v1/statement](https://app.creditcresttechnologies.com.au/developers/reference/statement#post-v1-statement) (key): A bank statement read: income, commitments, expenses and the signals an assessor should be told, each with the transactions behind it.
- [GET /v1/statement/accuracy](https://app.creditcresttechnologies.com.au/developers/reference/statement#get-v1-statement-accuracy): How well the reading is measured to be: precision, coverage, recall and F1 on each test set, per category and per release.
- [GET /v1/statement/sample](https://app.creditcresttechnologies.com.au/developers/reference/statement#get-v1-statement-sample): The same for an invented statement, so a program can be built before it has anybody’s data.
- [GET /v1/statement/sample.csv](https://app.creditcresttechnologies.com.au/developers/reference/statement#get-v1-statement-sample-csv): That invented statement as a bank’s CSV export, to send back to POST /v1/statement.

## Identity

- [GET /v1/identity](https://app.creditcresttechnologies.com.au/developers/reference/identity#get-v1-identity): Describes this API: what it takes and what it returns.
- [POST /v1/identity/contact/start](https://app.creditcresttechnologies.com.au/developers/reference/identity#post-v1-identity-contact-start) (key): {channel: email|mobile, destination, lender}
- [POST /v1/identity/contact/resend](https://app.creditcresttechnologies.com.au/developers/reference/identity#post-v1-identity-contact-resend) (key): {token}
- [POST /v1/identity/contact/check](https://app.creditcresttechnologies.com.au/developers/reference/identity#post-v1-identity-contact-check) (key): {token, code}
- [GET /v1/identity/address](https://app.creditcresttechnologies.com.au/developers/reference/identity#get-v1-identity-address): G-NAF suggestions
- [POST /v1/identity/id/start](https://app.creditcresttechnologies.com.au/developers/reference/identity#post-v1-identity-id-start) (key): {reference, callback}
- [POST /v1/identity/id/webhook](https://app.creditcresttechnologies.com.au/developers/reference/identity#post-v1-identity-id-webhook): The provider’s signed result (X-Signature-V2, with an X-Timestamp inside five minutes)
- [POST /v1/identity/decision](https://app.creditcresttechnologies.com.au/developers/reference/identity#post-v1-identity-decision) (key): {record, rules, asAt}
- [POST /v1/identity/record](https://app.creditcresttechnologies.com.au/developers/reference/identity#post-v1-identity-record) (key): {applicant, contacts, identity, address, rules, asAt}

## AML

- [GET /v1/aml](https://app.creditcresttechnologies.com.au/developers/reference/aml#get-v1-aml): Describes this API: what it takes and what it returns.
- [POST /v1/aml/cdd](https://app.creditcresttechnologies.com.au/developers/reference/aml#post-v1-aml-cdd) (key): {cip, screening, purpose}
- [POST /v1/aml/risk](https://app.creditcresttechnologies.com.au/developers/reference/aml#post-v1-aml-risk) (key): {customer, settings?}
- [POST /v1/aml/monitor](https://app.creditcresttechnologies.com.au/developers/reference/aml#post-v1-aml-monitor) (key): {accounts, settings?, holidays?}
- [POST /v1/aml/smr](https://app.creditcresttechnologies.com.au/developers/reference/aml#post-v1-aml-smr) (key): {events, asAt, holidays?}
- [GET /v1/aml/compliance-report](https://app.creditcresttechnologies.com.au/developers/reference/aml#get-v1-aml-compliance-report): The reporting window

## Payments

- [GET /v1/payments](https://app.creditcresttechnologies.com.au/developers/reference/payments#get-v1-payments): Describes this API: what it takes and what it returns.
- [POST /v1/payments/aba](https://app.creditcresttechnologies.com.au/developers/reference/payments#post-v1-payments-aba) (key): A BECS direct entry file, or the reasons it was refused
- [POST /v1/payments/debits](https://app.creditcresttechnologies.com.au/developers/reference/payments#post-v1-payments-debits) (key): The debits to raise on a day
- [POST /v1/payments/return](https://app.creditcresttechnologies.com.au/developers/reference/payments#post-v1-payments-return) (key): A returned debit as ledger events and conduct
- [POST /v1/payments/payto](https://app.creditcresttechnologies.com.au/developers/reference/payments#post-v1-payments-payto) (key): A PayTo agreement replayed
- [POST /v1/payments/reconcile](https://app.creditcresttechnologies.com.au/developers/reference/payments#post-v1-payments-reconcile) (key): {expected, settled}
- [POST /v1/payments/payouts](https://app.creditcresttechnologies.com.au/developers/reference/payments#post-v1-payments-payouts) (key): {contracts: [{reference, state, amount, payee, nameCheck}]}

## Credit Reporting

- [GET /v1/credit-reporting](https://app.creditcresttechnologies.com.au/developers/reference/credit-reporting#get-v1-credit-reporting): Describes this API: what it takes and what it returns.
- [POST /v1/credit-reporting/history](https://app.creditcresttechnologies.com.au/developers/reference/credit-reporting#post-v1-credit-reporting-history) (key): {reference, terms, events, arrangements?, asAt, grace?}
- [POST /v1/credit-reporting/submission](https://app.creditcresttechnologies.com.au/developers/reference/credit-reporting#post-v1-credit-reporting-submission) (key): {month, accounts: [{reference, terms, events, arrangements}], previous?}
- [POST /v1/credit-reporting/default](https://app.creditcresttechnologies.com.au/developers/reference/credit-reporting#post-v1-credit-reporting-default) (key): {terms, events, asAt, s6qNotice, s21dNotice, statuteBarred, hardshipRequest, threshold?}
- [POST /v1/credit-reporting/prepare](https://app.creditcresttechnologies.com.au/developers/reference/credit-reporting#post-v1-credit-reporting-prepare) (key): The month’s contribution as it would be sent, its SHA-256, and the check before a person at the lender approves it
- [POST /v1/credit-reporting/obligations](https://app.creditcresttechnologies.com.au/developers/reference/credit-reporting#post-v1-credit-reporting-obligations) (key): The lender’s filings replayed from its own events: each one’s step, due day, overdue flag and approval, and its enquiry log

## Complaints

- [GET /v1/complaints](https://app.creditcresttechnologies.com.au/developers/reference/complaints#get-v1-complaints): Describes this API: what it takes and what it returns.
- [POST /v1/complaints/clock](https://app.creditcresttechnologies.com.au/developers/reference/complaints#post-v1-complaints-clock) (key): One complaint replayed
- [POST /v1/complaints/register](https://app.creditcresttechnologies.com.au/developers/reference/complaints#post-v1-complaints-register) (key): The register with systemic grouping
- [POST /v1/complaints/extract](https://app.creditcresttechnologies.com.au/developers/reference/complaints#post-v1-complaints-extract) (key): The IDR data extract

## Privacy

- [GET /v1/privacy](https://app.creditcresttechnologies.com.au/developers/reference/privacy#get-v1-privacy): Describes this API: what it takes and what it returns.
- [POST /v1/privacy/access](https://app.creditcresttechnologies.com.au/developers/reference/privacy#post-v1-privacy-access) (key): {request: {receivedOn, kind, identityCheckedOn?, respondedOn?, refused?}, asAt}
- [POST /v1/privacy/correction](https://app.creditcresttechnologies.com.au/developers/reference/privacy#post-v1-privacy-correction) (key): {request: {receivedOn, kind, agreedInWritingUntil?, correctedOn?, noticeGivenOn?}, asAt}
- [POST /v1/privacy/register](https://app.creditcresttechnologies.com.au/developers/reference/privacy#post-v1-privacy-register) (key): The register checked
- [POST /v1/privacy/disposal](https://app.creditcresttechnologies.com.au/developers/reference/privacy#post-v1-privacy-disposal) (key): What falls due
- [POST /v1/privacy/breach](https://app.creditcresttechnologies.com.au/developers/reference/privacy#post-v1-privacy-breach) (key): {breach: {awareOn, assessedOn?, eligible?, ...}, asAt}
- [POST /v1/privacy/automated-decisions](https://app.creditcresttechnologies.com.au/developers/reference/privacy#post-v1-privacy-automated-decisions) (key): {uses: [...], decisions: [{kind, solely}], asAt}

## Documents

- [GET /v1/documents](https://app.creditcresttechnologies.com.au/developers/reference/documents#get-v1-documents): Describes this API: what it takes and what it returns.
- [POST /v1/documents/register](https://app.creditcresttechnologies.com.au/developers/reference/documents#post-v1-documents-register) (key): What the product must give, and before which step
- [POST /v1/documents/version](https://app.creditcresttechnologies.com.au/developers/reference/documents#post-v1-documents-version) (key): Checked for placeholders and hashed
- [POST /v1/documents/check](https://app.creditcresttechnologies.com.au/developers/reference/documents#post-v1-documents-check) (key): Whether a document may be issued: a credit guide missing an item s 126 requires may not
- [POST /v1/documents/proceed](https://app.creditcresttechnologies.com.au/developers/reference/documents#post-v1-documents-proceed) (key): {step, given: [{key, version, sha256, givenOn}], product, context?, library?, onDay?}
- [POST /v1/documents/assessment-copy](https://app.creditcresttechnologies.com.au/developers/reference/documents#post-v1-documents-assessment-copy) (key): {requestedOn, creditDay?}

## Apply

- [GET /v1/apply](https://app.creditcresttechnologies.com.au/developers/reference/apply#get-v1-apply): Describes this API: what it takes and what it returns.
- [GET /v1/apply/form](https://app.creditcresttechnologies.com.au/developers/reference/apply#get-v1-apply-form): The standard form for a kind of credit, and its coverage
- [POST /v1/apply/customise](https://app.creditcresttechnologies.com.au/developers/reference/apply#post-v1-apply-customise) (key): A lender’s form from a base
- [POST /v1/apply/coverage](https://app.creditcresttechnologies.com.au/developers/reference/apply#post-v1-apply-coverage) (key): Which topics the form covers, and which required ones it does not
- [POST /v1/apply/publish](https://app.creditcresttechnologies.com.au/developers/reference/apply#post-v1-apply-publish) (key): Refused while a required topic is unasked without an approved exception
- [POST /v1/apply/record](https://app.creditcresttechnologies.com.au/developers/reference/apply#post-v1-apply-record) (key): The sealed reasonable inquiries record

## Score

- [GET /v1/score](https://app.creditcresttechnologies.com.au/developers/reference/score#get-v1-score): Describes this API: what it takes and what it returns.
- [POST /v1/score](https://app.creditcresttechnologies.com.au/developers/reference/score#post-v1-score) (key): 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.
- [POST /v1/score/model-borrower](https://app.creditcresttechnologies.com.au/developers/reference/score#post-v1-score-model-borrower) (key): 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.
- [POST /v1/score/history](https://app.creditcresttechnologies.com.au/developers/reference/score#post-v1-score-history) (key): 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.
- [POST /v1/score/benchmark](https://app.creditcresttechnologies.com.au/developers/reference/score#post-v1-score-benchmark) (key): Build a model borrower’s profile from closed loans in one go.
- [POST /v1/score/validate](https://app.creditcresttechnologies.com.au/developers/reference/score#post-v1-score-validate) (key): 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.
- [POST /v1/score/update](https://app.creditcresttechnologies.com.au/developers/reference/score#post-v1-score-update) (key): Move a rating by repayment results: each instalment is a match.
- [GET /v1/l/:tenant/score/model-borrower](https://app.creditcresttechnologies.com.au/developers/reference/score#get-v1-l-tenant-score-model-borrower) (key): The lender’s model borrower: its name, rating, profile and window, and every loan that moved it, from the lender’s own records.
- [GET /v1/l/:tenant/score/history/:loanRef](https://app.creditcresttechnologies.com.au/developers/reference/score#get-v1-l-tenant-score-history-loanref) (key): 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.

## Sign

- [GET /v1/sign](https://app.creditcresttechnologies.com.au/developers/reference/sign#get-v1-sign): Signing for any document.
- [POST /v1/sign/requests](https://app.creditcresttechnologies.com.au/developers/reference/sign#post-v1-sign-requests) (key): Ask for a signature.
- [POST /v1/sign/evidence](https://app.creditcresttechnologies.com.au/developers/reference/sign#post-v1-sign-evidence) (key): 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.
- [POST /v1/sign/certificate](https://app.creditcresttechnologies.com.au/developers/reference/sign#post-v1-sign-certificate) (key): 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.
- [POST /v1/sign/verify](https://app.creditcresttechnologies.com.au/developers/reference/sign#post-v1-sign-verify) (key): Check evidence and its seal, and the document if you send it: valid, or exactly why not, each reason with a code.

## Authentication

- [GET /v1/keys](https://app.creditcresttechnologies.com.au/developers/authentication#get-v1-keys): Describes this API: what it takes and what it returns.
- [POST /v1/keys/sandbox](https://app.creditcresttechnologies.com.au/developers/authentication#post-v1-keys-sandbox): A sandbox key, straight away, for 30 days.
- [GET /v1/keys/me](https://app.creditcresttechnologies.com.au/developers/authentication#get-v1-keys-me) (key): What the key you sent is: its id, lender, mode, scopes and expiry.
- [GET /v1/usage](https://app.creditcresttechnologies.com.au/developers/authentication#get-v1-usage) (key): 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.
- [GET /v1/admin/usage](https://app.creditcresttechnologies.com.au/developers/authentication#get-v1-admin-usage): Creditcrest’s own: every lender’s month, priced, for invoicing.
- [GET /v1/admin/invoices/:lender](https://app.creditcresttechnologies.com.au/developers/authentication#get-v1-admin-invoices-lender): 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.
- [POST /v1/admin/invoices/:lender/adjustments](https://app.creditcresttechnologies.com.au/developers/authentication#post-v1-admin-invoices-lender-adjustments): 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.
- [POST /v1/admin/usage](https://app.creditcresttechnologies.com.au/developers/authentication#post-v1-admin-usage): Creditcrest’s own: puts back counts that could not be written at the time, each once.

## Hosted Application

- [POST /v1/l/:tenant/applications](https://app.creditcresttechnologies.com.au/developers/reference/journey#post-v1-l-tenant-applications) (key): 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.

## Capacity

- [GET /v1/capacity](https://app.creditcresttechnologies.com.au/developers/reference/capacity#get-v1-capacity): The same on the invented ordinary statement, for any loan in the query.
- [POST /v1/capacity](https://app.creditcresttechnologies.com.au/developers/reference/capacity#post-v1-capacity) (key): Serviceability and borrowing power for a loan, on a statement sent in the body.

## Enrich

- [GET /v1/enrich](https://app.creditcresttechnologies.com.au/developers/reference/enrich#get-v1-enrich): One transaction.
- [POST /v1/enrich](https://app.creditcresttechnologies.com.au/developers/reference/enrich#post-v1-enrich) (key): A list of transactions, up to 20,000 in one request, with the coverage of the whole list.
- [GET /v1/enrich/rules](https://app.creditcresttechnologies.com.au/developers/reference/enrich#get-v1-enrich-rules): What the engine is made of: the categories it can assign and how many rules it holds.
- [GET /v1/enrich/accuracy](https://app.creditcresttechnologies.com.au/developers/reference/enrich#get-v1-enrich-accuracy): What it gets right, measured against payee lists nobody here chose, per category and per confidence band.

## Index

- [GET /v1](https://app.creditcresttechnologies.com.au/developers/reference#get-v1): Describes this API: what it takes and what it returns.

## Collections

- [GET /v1/hardship-clock](https://app.creditcresttechnologies.com.au/developers/reference/collections#get-v1-hardship-clock): Put a hardship matter on the statutory clock.
- [GET /v1/hardship-clock/provisions](https://app.creditcresttechnologies.com.au/developers/reference/collections#get-v1-hardship-clock-provisions): Every period this engine knows, with the provision it comes from, for a credit contract and for a consumer lease.

## Decisioning

- [GET /v1/decisioning](https://app.creditcresttechnologies.com.au/developers/reference/decisioning#get-v1-decisioning): A lender’s own credit policy, versioned and replayable against the version that was in force on the day.
- [GET /v1/decisioning/policy](https://app.creditcresttechnologies.com.au/developers/reference/decisioning#get-v1-decisioning-policy): One of the example policies on this surface: every version, its dates, the hash of its rules, and every clause in it.
- [GET /v1/decisioning/replay](https://app.creditcresttechnologies.com.au/developers/reference/decisioning#get-v1-decisioning-replay): 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.
- [POST /v1/decisioning/run](https://app.creditcresttechnologies.com.au/developers/reference/decisioning#post-v1-decisioning-run) (key): 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.
- [POST /v1/decisioning/shadow](https://app.creditcresttechnologies.com.au/developers/reference/decisioning#post-v1-decisioning-shadow) (key): 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.
- [GET /v1/shadow](https://app.creditcresttechnologies.com.au/developers/reference/decisioning#get-v1-shadow): 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.
- [POST /v1/shadow](https://app.creditcresttechnologies.com.au/developers/reference/decisioning#post-v1-shadow) (key): 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.
- [POST /v1/shadow/report](https://app.creditcresttechnologies.com.au/developers/reference/decisioning#post-v1-shadow-report) (key): 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.
- [GET /v1/l/:tenant/shadow](https://app.creditcresttechnologies.com.au/developers/reference/decisioning#get-v1-l-tenant-shadow) (key): 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.

## Record

- [GET /v1/decisioning/record](https://app.creditcresttechnologies.com.au/developers/reference/record#get-v1-decisioning-record): The same application sealed into a record, verified, amended by appending, and edited so the verification fails.

## Webhooks

- [Webhooks](https://app.creditcresttechnologies.com.au/developers/webhooks): notices to your own endpoint, signed with Creditcrest-Signature (HMAC-SHA256 of "<t>.<body>"), retried for 72 hours; ids and what changed, never a borrower's details
- application.submitted (v1): An application was submitted, read and assessed, and is in the lender’s work queue
- application.decided (v1): 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
- application.withdrawn (v1): An application will go no further: the applicant carried on with another one, or the lender’s staff closed the file as withdrawn
- contract.signed (v1): The borrower signed the contract
- loan.funded (v1): The advance settled, and the contract is funded
- repayment.collected (v1): A payment was put on a loan’s account
- repayment.failed (v1): A repayment did not arrive: a payment already on the account was reversed (a dishonour), or a PayTo debit failed before it was paid
- hardship.requested (v1): A borrower asked for hardship help
- hardship.arranged (v1): A hardship arrangement started on a loan
- complaint.received (v1): A complaint was received
- daily_run.completed (v1): The daily run Creditcrest runs for the lender finished a day: the day before sealed, what is due today listed and held
- webhook.test (v1): A test, sent from the Webhooks page of the lender’s console