Changelog
Changes to the API and to this documentation, newest first. Within API version 2 all changes are additive; see Versioning.
Documentation
Documentation rebuilt
- New site: plain HTML and CSS, no external dependencies, dark mode, search, persistent language selection, copy buttons.
- Reference rewritten and expanded: response conventions, polling, regions, dates and numbers, line items, duplicates and retries, limits, security, versioning.
- Code samples rewritten for curl, Node.js, Python, PHP, Ruby, Java, Go and C#/.NET using current standard libraries, with a full upload-and-poll program per language. Every sample is a real file run against a mock of the API by an automated test suite.
- Fixed: misspelled API host in the endpoint list, inconsistent multipart field names across samples, samples that did not compile or referenced undefined variables, the
.NETtab labelled as curl, template placeholder text left in the page. - Removed: the
testModeparameter (no longer supported), PDF as an upload format, the multiple-image feature section. - Added: OpenAPI 3.1 specification, JSON Schema for the result object, llms.txt and llms-full.txt, and a page for AI agents.
API version 2
Additions to version 2 since the previous documentation, most recent first. Exact release dates are being collected; contact support if you need to know whether a field is available on your account.
Tip and service charges
New result fields tip, tipConfidence, serviceCharges and serviceChargeConfidences, and the Tip and ServiceCharge values of lineType in summaryItems.
Date and establishment confidence
New result fields dateConfidence and establishmentConfidence.
Line classification
New lineType field on every line item, classifying summary lines as Total, SubTotal, Tax, TotalTax, Cash, Change, Tip or ServiceCharge.
Region parameter
New optional form field region on the process endpoint, selecting country-specific parsing rules.
Credit endpoint
New GET /api/credit returning the remaining credit.
Currencies
Currency detection extended with CAD and ZAR.
testMode removed
The testMode form field is no longer accepted. Duplicate detection (the duplicate and duplicateToken response fields) covers the repeated-upload use case.
Multiple API keys
Accounts can hold more than one API key, allowing rotation without downtime.