Skip to main content

15 docs tagged with "api"

View all tags

Authentication

OAuth 2.0 client credentials. Keycloak issues the token; APIs consume Bearer.

Book a document

Multipart POST on a Docbooks workspace. 409 if extraction is not provisioned.

Conventions

Identifiers, lists, JSON, files, time, idempotency, rate limits.

Docbooks

Book Swiss receipts. Organisations and workspaces are setup around that job.

Docmind

Extract structured data from invoices, receipts, and other business documents.

Document types

Every documentType on the released Docmind contract, with invoice and receipt samples.

Enable capture and booking

Docbooks books via Docpier extraction behind the scenes. Call Docmind only if you also need capture in your own product.

Errors

Flat {code, message} error body shared by Docmind and Docbooks.

Onboard

Create organisations and workspaces; offboard in batches.

Send feedback

Batch POST of corrected booking resources. HTTP 200 with per-item SUCCESS or ERROR.

Send feedback

Tell Docmind when an operator corrects an extracted document.

Split a bundle

options JSON — extract.split.enabled fans a PDF into child documents.

Webhooks

Docpier POSTs to your URL. Envelope, events, delivery.