Base URL
All API requests are made to the Vantage production server:Authentication
The Vantage API uses OAuth 2.0 for authentication. Every request must include an access token in the Authorization header:Contact ABBYY to request a tenant in ABBYY Vantage. Once you have a tenant account, you can create user accounts and API clients for authentication.
Processing API
The Processing API (/api/publicapi/v1/) enables you to:
- Create transactions — Submit documents for processing with a specific skill
- Manage files — Upload, edit, and organize document images
- Track status — Monitor transaction progress and handle errors
- Retrieve results — Download extracted data in JSON or XML format
- Manage catalogs — Work with data catalogs and lookup tables
Common Workflows
- Processing Documents with a Single API Call — Process documents with a single request that handles upload, processing, and result retrieval automatically.
- Processing Documents with Separate API Calls — Use separate API calls for fine-grained control over document upload, processing, and result retrieval.
- Integrating Manual Review — Integrate manual review into your workflow for documents requiring human verification.
Reporting API
The Reporting API (/api/reporting/v2/) provides access to:
- Business metrics — Transaction volumes, processing times, and throughput
- Quality analytics — Extraction accuracy and confidence scores
- Field-level data — Detailed extraction results for analysis
Output Formats
Vantage returns extracted data in structured formats:- JSON Output — Hierarchical data with full extraction details and confidence scores
- XML Output — Structured markup for systems requiring XML integration
Developer Resources
- Getting Started with the Vantage API — Start here — make your first call, authenticate, and choose a processing scenario
- Postman Collection — Ready-to-use API collection for testing and exploration
Rate Limits & Best Practices
- Batch operations — Use batch endpoints when processing multiple records (up to 5,000 catalog records per request)
- Polling — When checking transaction status, use reasonable intervals (5-10 seconds)
- Error handling — Implement retry logic with exponential backoff for transient errors
Next Steps
1
Set Up Authentication
Configure OAuth 2.0 for your application
2
Process Your First Document
Follow the processing guide to submit a document
3
Explore the API
Browse the full Processing API and Reporting API references
