API reference
Decisioning
Your policy. Replayable. Open the product
GET/v1/decisioningOpen ↗
A lender’s own credit policy, versioned and replayable against the version that was in force on the day.
GET/v1/decisioning/policyOpen ↗
One of the example policies on this surface: every version, its dates, the hash of its rules, and every clause in it.
| Query | |
|---|---|
policy | which example policy: round-numbers, guideline-shaped — default round-numbers |
GET/v1/decisioning/replayOpen ↗
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.
| Query | |
|---|---|
income | monthly pay credited to the account, dollars |
other | monthly income of a kind that is not wages — rental, dividends, side work — dollars. |
rent | monthly rent, dollars |
everyday | monthly card spending on groceries, fuel and utilities, dollars |
gambling | monthly spending with a wagering operator, dollars |
benchmark | the lender’s own monthly expense benchmark for this household, dollars — supplied by the lender, because this repository holds no benchmark table |
declared | what the applicant said they spend each month, dollars |
debt | 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 |
gross | gross annual income before tax, dollars a year — the other half, and not a figure a bank statement carries |
amount | the amount applied for, dollars |
rate | the annual rate offered before the assessment buffer, per cent |
years | the term applied for, years |
on | the day the application was assessed, YYYY-MM-DD — which decides which version it is replayed against |
policy | which example policy to replay against: round-numbers, guideline-shaped — default round-numbers. |