Getting started

Four steps to your first extraction: get an API key, upload a file, create a job, then poll or use webhooks and export.

Step 1: Get an API key

Sign in at DocuClipper → Account → API Settings. Create an API key and use it as a Bearer token in every request.

Step 2: Upload a file

bash
curl -X POST "https://www.docuclipper.com/api/v1/protected/document" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "document=@statement.pdf"

Supported: PDF, PNG, JPEG, CSV, XLSX. Response includes document.id.

Step 3: Create a job

bash
curl -X POST "https://www.docuclipper.com/api/v1/protected/job" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"jobName":"","documents":["DOCUMENT_ID"],"enableBankMode":true}'

For bank statements use enableBankMode: true. For invoices use jobType: "Invoice", for tax forms jobType: "Form".

Step 4: Poll and export

Poll GET /api/v1/protected/job/JOB_ID until status === "Succeeded", then export:

bash
curl -X POST "https://www.docuclipper.com/api/v1/protected/job/JOB_ID/export" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"jobType":"FieldsToExcel1","flattenTables":true,"format":"json"}'

For production, use webhooks instead of polling.