API reference
Capacity
See the arithmetic. Open the product
GET/v1/capacityOpen ↗
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 |
POST/v1/capacityKey
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 |
the CSV export as text/csv with the loan in the query, or JSON {statement, loan, rate, years, …}