← All docs

Reference

POST /v1/extract

The one endpoint: a file and a schema in, typed values with a confidence per field out.

Multipart form data. Four inputs, of which two are required.

file · required

PDF, PNG, JPEG, TIFF or HEIC, up to 20 pages and 25 MB. Phone photos and scans are read as they are; there is no need to straighten them first.

schema · required

A JSON Schema, sent as a file or a string. See Schemas for the types it can describe.

threshold · optional

A number from 0 to 1, 0.9 by default. Fields under it are returned in review.

locale · optional

A BCP 47 tag such as de-DE. It settles dates and decimal separators when the document leaves them ambiguous.

Response · 200

{
  "values": { "total": 1284.50, "due": "2026-12-01" },
  "confidence": { "total": 0.998, "due": 0.973 },
  "review": [],
  "pages": 1,
  "certificate": "TX-2611-0412"
}