Read results
A job's state, its files, what the processor found, and the deal's financials — in one call.
Loading documentation…
GET /v1/api/jobs/{id} · scope read
state is what to act on:
state | Means | Final? |
|---|---|---|
awaiting_start | Declared, not started. | No |
processing | Running. | No |
completed | Done; nothing is missing. | Yes |
needs_information | Done; the deal still lacks something — see the missing_information finding. | Yes |
failed | The job could not finish. | Yes |
Poll every 5 seconds for the first minute, then every 30, until the state is final. There are no webhooks.
files are the job's documents: id, name, contentType, sizeBytes, documentType,
periodStart and periodEnd when known, createdAt, and source.
job is the processing run in full:
| Field | Holds |
|---|---|
status | The detailed step: started, documents_complete, post_processing, generating_insights, aggregation_complete, research_complete, lenders_matched, insights_ready, then facility_ready, missing_info or failed. state is this, collapsed. |
finished, finishedAt | Whether it ended, and when. |
events | Every step the processor reported, in order: {seq, event, at, detail}. |
documents | One line per file per attempt: fileId, fileName, documentType, outcome (pending, started, succeeded, partial, failed, skipped), reason when it failed, and extractions. |
A document's extractions are the fields read off it, one envelope per kind:
confidenceBps is basis points — 9300 is 93%.
findings are the processor's judgements on the job, the latest version of each —
Findings says what each one holds. Empty until the processor has posted one.
financials is the deal's headline numbers, each from the newest job that produced it:
| Field | Holds |
|---|---|
banking.monthlyRevenueMinor | Average monthly revenue, in cents. |
banking.averageDailyBalanceMinor | Average daily balance, in cents. |
banking.nsfCount, banking.positions | NSFs, and merchant cash advance positions. |
banking.months, banking.files | How many statement months and files it read. |
credit.score, credit.bureau, credit.pulledAt | The credit score, when a report stated one. Absent is unknown, never zero. |
A half nobody has produced yet has an empty jobId.
GET /v1/api/jobs · scope read
Newest first: [{id, jobId, status, state, requestedAt, finishedAt}], and nextBefore — pass it
as before for the next page. It is null once a page comes back short; a last page that is
exactly full carries one more cursor, which answers an empty page. limit is 1–200, default 50. A
job that was declared but never started isn't listed.
The list is every started job on the key's page, not only this key's: keys that aren't attached to a board share one page per workspace, so each sees the others' jobs. A Deals key lists the Deals page's jobs.