1. Documentation
  2. Processor
  3. Best practices
Open Specter
  • Introduction
  • Quickstart
  • Authentication
  • Errors
  • Rate limits
  • Best practices
  • Overview
  • Access
  • Best practices
  • Create a key
  • Read and write
  • Overview
  • Best practices
  • Hosted page
  • Submit from your code
  • Drafts, files and corrections
  • Overview
  • Best practices
  • Create a key
  • Send documents
  • Read results
  • Findings
  • Process a deal
  • Errors and limits

Best practices

Sending documents cleanly and reading the answers right.

Loading documentation…

Overview< PreviousCreate a keyNext >
  • One job per deal. Declare a deal's files together — up to 25 — rather than a job per file. What's missing is judged across the documents in one job.
  • A key per integration, with only what it needs. Something that only sends documents and reads the answer needs processing and read, and a key that isn't attached to a board holds nothing else.
  • Upload everything, then start. The processor fetches the files when the job starts; a file still uploading is a file it can't read.
  • Send the declared Content-Type. The upload URL is signed for the type you declared, and it expires after 15 minutes — declare again for a fresh one.
  • Say what you know. A documentType and a statement's periodStart/periodEnd save the processor guessing.
  • Pass productType on start. It decides what counts as missing — an MCA and a term loan need different documents.
  • Retry a start freely. Starting the same files twice answers the job already running; it never bills twice — as long as each retry sends the same idempotencyKey, or none.
  • Poll gently. Every 5 seconds for the first minute, then every 30, until state is final.
  • Act on state, then the findings. needs_information means read the missing_information finding and ask the sender for its missing_items.
  • Treat money as cents. monthlyRevenueMinor and averageDailyBalanceMinor are minor units; a credit score that's absent is unknown, not zero.