API reference
Score
Measured against your own book. Open the product
GET/v1/scoreOpen ↗
Describes this API: what it takes and what it returns.
POST/v1/scoreKey
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.
{ statement (CSV text) | application (reading, assessment, history, answers…), amount, termMonths, frequency, scale: elo | plain, loanType?, model? (the model borrower for the loan type, as /v1/score/model-borrower returned it), lender?, reference? (the application’s), loan? }POST/v1/score/model-borrowerKey
Count completed and written-off loans in the lender’s model borrower for one loan type, up to 25 a call: its own rating moves with each by K × (result − expected). Its profile is Creditcrest’s shared one for the type. A write-off with hardship relief is a loss, counted apart. Send it back each time; each loan counts once.
{ model? | lender, loanType?: sacc | macc | personal | secured | car | business, 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) }] }POST/v1/score/historyKey
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.
{ history: [the entries so far, first to last], terms, events (the ledger’s events), through: YYYY-MM-DD, graceDays?, model? }POST/v1/score/benchmarkKey
Build a model borrower’s profile from closed loans in one go.
{ loans: [{ measures, outcome: good|bad|neither, closedOn }], from?, to? }POST/v1/score/validateKey
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.
{ loans: [{ rating, outcome }] }POST/v1/score/updateKey
Move a rating by repayment results: each instalment is a match.
{ rating, results: [{ result: on time|late|missed|plan kept }], baseRate? }GET/v1/l/:tenant/score/model-borrowerKey
The lender’s model borrower for a loan type (?type=sacc, macc, personal, secured, car or business; the first it offers if none): its name, its own rating, the shared profile for the type, and every one of its loans that moved it.
GET/v1/l/:tenant/score/history/:loanRefKey
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.