Use cases
The on-prem image exposes three endpoints.
All of them take multipart/form-data and accept the image parts described in Image formats.
Verify a document
POST /api/v3/verify
Extracts data from a document and runs verification checks against it: whether the document is authentic, whether it has been tampered with or presented from a screen, and whether the data on it is internally consistent.
Returns the extraction result, the individual check results, and an overall verdict.
- Checks: what each check does.
- Verdict: how the individual checks resolve into a single outcome.
- Response: the shape of the response.
- Configuration: the settings that control which checks run and how strict they are.
- Example configurations: configurations for common scenarios.
Extract document data
POST /api/v3/extract
Extracts data from a document without running verification checks.
Which sides are scanned is determined by which image parts you send, not by the URL you call: send imageFirstSide alone for a single-side scan, or both imageFirstSide and imageSecondSide for a multi-side scan.
Scan and parse a barcode
POST /api/v3/extract-barcode
Reads a barcode from a standalone image and parses its payload.