API reference
Operations
Every handover is visible. Open the product
GET/v1/operationsOpen ↗
Describes this API: what it takes and what it returns.
POST/v1/operations/caseKey
The file replayed
{workflow?, people, events, asAt, holidays?, reference?, priority?}POST/v1/operations/queueKey
The queue, in the order to pick files up
{workflow?, people, cases: [{reference, priority, events}], asAt}POST/v1/l/:tenant/staff-sessionsKey
A sign-in link to the lender’s operations console for one of its staff, lasting ten minutes and working once. The lender’s own key is needed outside the sandbox. Send a name and a role; or the work email of a person on the lender’s staff list, to sign them in as the list has them — the way in before sign-in links can be emailed, and how a person adds their first passkey then.
| Body | |
|---|---|
name | the staff member’s full name, as it will appear on every change they make |
role | assessor | senior | compliance | admin | auditor |
email | or: the work email of an active person on the lender’s staff list |
GET/v1/l/:tenant/casesKey
The work queue as the operations console shows it: open files first, those past their service level first, 25 a page. Needs that lender’s API key.
| Query | |
|---|---|
state | open | all | received | in review | waiting on applicant | concluded | withdrawn |
ownership | all | unassigned | mine (mine needs by) |
q | a reference, name, email, customer id or mobile |
flood | 1: only the files that look automated |
page | from 1 |
by | optional: the work email of a person on the staff list, whose files are mine and who may close which |
GET/v1/l/:tenant/cases/:refKey
One application’s case file as data: the applicant, the answers, the statement’s reading, the policy and score in shadow, verification, the ledger, the checklist, documents, notes, credit enquiries, the conclusion, the contract and the audit trail. Needs that lender’s API key.
| Query | |
|---|---|
by | optional: the work email of a person on the staff list, to say what they may do with the file now (for) |
POST/v1/l/:tenant/cases/close-automatedKey
Close files as automated submissions, up to 100 at once, as the queue does in a bot flood: each the person may close, at the seq it was read at; the rest listed with why. Needs that lender’s API key.
| Body | |
|---|---|
by | the work email of the person on the lender’s staff list who did it: their role there decides what they may do, and they are named on the event |
reason | what showed they were automated |
applications | [{ref, seq}]: each file, at the seq it was read at; at most 100 |
POST/v1/l/:tenant/cases/:ref/actionsKey
One action on an application by a person on the staff list, through the console’s own checks: their role there decides, the event names them, and the case comes back as it stands. Each action and its fields are listed under actions in GET /v1/l. Needs that lender’s API key.
{action, by, seq?, …the action’s own fields}