API reference
Statement
Follow every figure. Open the product
GET/v1/evidenceOpen ↗
Describes this API: what it takes and what it returns.
POST/v1/evidence/coverageKey
{product, accounts: [{id, role, from, to}], applicationDay, selfEmployed?, refinancing?, policy?}GET/v1/statementOpen ↗
Describes this API: what it takes and what it returns.
POST/v1/statementKey
A bank statement read: income, commitments, expenses and the signals an assessor should be told, each with the transactions behind it.
the CSV export as text/csv, or JSON {statement, declaredIncome?, declaredIncomeSource?} plus any capacity fieldGET/v1/statement/sampleOpen ↗
The same for an invented statement, so a program can be built before it has anybody’s data.
| Query | |
|---|---|
example | which invented statement: ordinary, strained |
GET/v1/statement/sample.csvOpen ↗
That invented statement as a bank’s CSV export, to send back to POST /v1/statement.
| Query | |
|---|---|
example | which invented statement: ordinary, strained |