Overview
Send a deal's documents to the Specter processor with your workspace's key, and read back what it found.
Loading documentation…
The processor reads a deal's documents — bank statements, applications, tax returns, credit reports and more — and answers what is still missing, how each bank statement scores for fraud, which lenders fit, and the deal's headline financials.
| You have | Use |
|---|---|
| Documents arriving by email | Send them to processor@spectersystems.io from your workspace — no key |
| A server or script holding the files | A processing key and the job routes |
| Deals already on your Deals page | A Deals key and the deal routes |
Every way in files the same job in your workspace, so a document gives the same answer whichever way it came.
A processing key spends money and reads your deals' documents. Keep it on a server, in an environment variable or a secret manager.
POST /v1/api/jobs with each file's name, type and size. The answer carries one upload URL per file.
PUT each file straight to its URL. The bytes never pass through the API.
POST /v1/api/jobs/{id}/start hands the files to the processor.
GET /v1/api/jobs/{id} until state is final — then the findings and financials are in the same answer.
| Route | Scope | Does |
|---|---|---|
POST /v1/api/jobs | processing | Declare a job's files; answers upload URLs |
POST /v1/api/jobs/{id}/start | processing | Start processing |
GET /v1/api/jobs/{id} | read | State, files, the job's progress, findings and financials — one call |
GET /v1/api/jobs | read | The newest jobs on the key's page, paged |
The routes under /v1/ingest/rows/{rowId}/… do the same for a deal that is already on your Deals
page — see Process a deal.
Keys, errors and rate limits follow the rules every Specter route shares: Authentication, Errors, Rate limits.