API reference

Capacity

GET`/v1/capacity`Open ↗

The same on the invented ordinary statement, for any loan in the query.

Query
`loan`	the amount applied for, dollars
`rate`	the annual rate, per cent
`years`	the term, years
`benchmark`	the lender’s own monthly expense benchmark, dollars
`declared`	monthly expenses the applicant declared, dollars
`minimum`	the lender’s surplus floor, dollars a month
`gross`	gross annual income, dollars
`debts`	other debts the lender counts, dollars
`cards`	credit card limits, dollars
`retiring`	commitments that end before the loan starts, by description
`setting`	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%; complete gives every line a category, guessing where nothing read it, and marks each guess.

Serviceability and borrowing power for a loan, on a statement sent in the body.

Query
`loan`	the amount applied for, dollars
`rate`	the annual rate, per cent
`years`	the term, years
`benchmark`	the lender’s own monthly expense benchmark, dollars
`declared`	monthly expenses the applicant declared, dollars
`minimum`	the lender’s surplus floor, dollars a month
`gross`	gross annual income, dollars
`debts`	other debts the lender counts, dollars
`cards`	credit card limits, dollars
`retiring`	commitments that end before the loan starts, by description
`setting`	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%; complete gives every line a category, guessing where nothing read it, and marks each guess.

Body

the CSV export as text/csv with the loan in the query, or JSON {statement, loan, rate, years, setting?, …}