Send documents
Declare a job's files, upload their bytes, and start it.
Loading documentation…
Three calls: declare the files, upload each one, start the job.
POST /v1/api/jobs · scope processing
A 201 answers the job's id and one upload URL per file. Nothing is processed yet — the bytes
aren't there.
| Field | Rules |
|---|---|
files | 1–25 files. |
files[].name | Required. |
files[].sizeBytes | Required, more than 0. |
files[].contentType | The file's type. Blank is application/octet-stream. |
files[].documentType | Optional — what it is, if you know: bank_statement, tax_return, application, credit_report, voided_check, drivers_license, id, contract, agreement, offer_letter, payoff_letter, invoice, statement_analysis, stip, signed_application, merchant_questionnaire, plaid_report, financials, profit_and_loss, balance_sheet, ucc_filing, business_license, articles_of_incorporation, insurance, lease, ar_report or other. Leave it out and the processor classifies the file. |
files[].periodStart, files[].periodEnd | Optional, YYYY-MM-DD — the span a statement covers. |
cells | Optional — values for the deal's own columns, as strings, keyed by column label or id, as on Boards. |
The file rules below are checked before anything is written, so a list they refuse leaves nothing behind.
| Refusal | Means |
|---|---|
at least one file is required | files is empty. |
at most 25 files per job | Split the documents across jobs, or send the most recent. |
every file needs a name and a positive sizeBytes | A file is missing its name or size. |
documentType must be one of … | An unknown type; the message lists the accepted ones. |
PUT the bytes to the file's uploadUrl, with the same Content-Type you declared — the URL
is signed for it, and a different type is refused. Each URL works for 15 minutes.
The upload goes straight to storage; the key isn't sent and isn't needed.
POST /v1/api/jobs/{id}/start · scope processing
Start only after every upload has finished: the processor fetches the files when it begins.
| Field | Rules |
|---|---|
productType | Optional. The deal type — mca, term_loan, line_of_credit, sba, or one your workspace named. It picks what the processor counts as missing. |
idempotencyKey | Optional. Your own key for this start. |
replace | Optional. Consent to replace fields a person entered by hand — see 409 below. |
The body is optional; a bare POST starts the job.
| Status | Means |
|---|---|
201 | Started. data is {id, state, created: true, job}. |
200 | This job was already started with these files — created: false, and job is the one already running. Safe to call again. |
400 | The job has no documents to process. |
409 | would_supersede: processing would replace fields a person entered by hand. The answer lists them in superseded; send "replace": true to go ahead. |
Starting twice with the same files never starts a second job: without an idempotencyKey the job
is keyed by its files, so a retry answers the job already running. A retry that sends a different
idempotencyKey starts a second job — reuse the key, or leave it out.
Then read the results.