For AI agents

This page is the canonical “how to use this API” reference for automated tools and AI agents.

OpenAPI spec (JSON) →llms.txt →

Stable machine-readable endpoints

  • OpenAPI 3.0: https://www.docuclipper.com/api-docs/openapi.json (also mirrored at https://www.docuclipper.com/api-docs/.well-known/openapi.json)
  • LLM hint file: https://www.docuclipper.com/api-docs/llms.txt (high-level usage + links)

Auth + base URL

bash
BASE="https://www.docuclipper.com/api/v1"
API_KEY="YOUR_API_KEY"

# Every request:
Authorization: Bearer $API_KEY

Canonical workflow

  1. Upload a document: POST /protected/document
  2. Create a job: POST /protected/job
  3. Wait for status === "Succeeded" (poll or use webhooks)
  4. Export extracted results: POST /protected/job/<id>/export with format: "json"

Job types (create job + export)

  • Bank statements / check images: create job with { enableBankMode: true } (omit jobType), export with { jobType: "FieldsToExcel1", format: "json" }
  • Invoices: create job with { jobType: "Invoice" }, export with { jobType: "Invoice", format: "json" }
  • Tax forms: create job with { jobType: "Form" }, export with { jobType: "Form", format: "json" }. Response is a documentId → array map where each item has rowNumber, pageNumber, and form (dynamic key-value fields).

Fraud signals

For bank-statement fraud features, use GET /protected/document/<documentId>/fraudSignals after extraction completes.

Human docs