How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ABBYY Vantage Processing REST API

Public REST API for ABBYY Vantage intelligent document processing. Create transactions, upload and order files, launch AI skills for classification, extraction and OCR, poll transaction status, download extracted JSON/XML results, generate mobile-input links, and manage data catalogs and their records. OAuth 2.0 authorization-code flow against the tenant auth server; 30 operations across six resource groups.

ABBYY Vantage Processing REST API is one of 4 APIs that ABBYY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Document Processing, OCR, Intelligent Document Processing, Data Extraction, and AI Automation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 30 operations across 26 paths, organized into 6 resource areas, and defines 52 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 3 base URLs: https://vantage-us.abbyy.com, https://vantage-eu.abbyy.com, https://vantage-au.abbyy.com.

30 operations 26 paths 52 schemas 2 DELETE16 GET12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://vantage-us.abbyy.com
Authentication
OAuth 2.0
Resource Areas
6

Authentication & Security 1

ABBYY Vantage Processing REST API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the authorizationCode flow, exposing 3 scopes. By default, every request must be authenticated.

Paths & Operations 30

Across 26 paths, the API surfaces 30 operations — 2 DELETE, 16 GET, 12 POST. They span 6 resource areas: CatalogRecords, Catalogs, Invites, Skills, TransactionDocuments, Transactions. Each is listed below with its method, path, parameters, and response codes.

CatalogRecords 4
POST
/api/publicapi/v1/catalogs/{catalogId}/records
Adds records to the specified catalog
AddRecords 1 param body → 200400404
GET
/api/publicapi/v1/catalogs/{catalogId}/records
Lists a portion of the records in the specified catalog
GetRecords 3 params → 200404
GET
/api/publicapi/v1/catalogs/{catalogId}/records/{recordId}
Gets a record
GetRecord 2 params → 200404
POST
/api/publicapi/v1/catalogs/{catalogId}/records/delete
Deletes the specified records from the catalog
DeleteRecords 1 param body → 200404
Catalogs 5
GET
/api/publicapi/v1/catalogs
Lists all available catalogs
GetCatalogs → 200
GET
/api/publicapi/v1/catalogs/{catalogId}
Gets detailed information about the catalog
GetCatalog 1 param → 200404
POST
/api/publicapi/v1/catalogs/{catalogId}/clear
Deletes all records from the catalog
ClearCatalog 1 param → 200404
POST
/api/publicapi/v1/catalogs/{catalogId}/reindex
Starts a catalog reindex operation
StartCatalogReindex 1 param → 200404
GET
/api/publicapi/v1/catalogs/{catalogId}/reindex/{reindexOperationId}
Gets detailed information of reindex operation
GetReindexOperation 2 params → 200404
Invites 1
POST
/api/publicapi/v1/invites
Creates invite for new tenant
CreateInvite body → 200400403
Skills 2
GET
/api/publicapi/v1/skills
Lists all available skills
GetAvailableSkills → 200
GET
/api/publicapi/v1/skills/{skillId}
Gets the detailed information about a skill
GetSkillInfo 1 param → 200404
TransactionDocuments 6
POST
/api/publicapi/v1/transactions/{transactionId}/documents
Creates a transaction document that will be used to group some files in single processing unit
CreateTransactionDocument 1 param body → 201400403404
GET
/api/publicapi/v1/transactions/{transactionId}/documents
Gets transaction documents
GetTransactionDocuments 1 param → 200400403404
GET
/api/publicapi/v1/transactions/{transactionId}/documents/{documentId}
Gets transaction document info
GetTransactionDocument 2 params → 200400403404
DELETE
/api/publicapi/v1/transactions/{transactionId}/documents/{documentId}
Deletes the document from specified transaction
DeleteTransactionDocument 2 params → 200400403404
POST
/api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles
Adds files to the transaction document
AddFilesToTransactionDocument 2 params body → 200400403404409
GET
/api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles/{fileId}/download
Downloads the source file of the transaction
DownloadTransactionDocumentSourceFile 3 params → 200403404
Transactions 12
POST
/api/publicapi/v1/transactions
Creates a processing transaction
CreateTransaction body → 201400404
POST
/api/publicapi/v1/transactions/{transactionId}/files
Adds files to the transaction
AddFilesToTransaction 1 param body → 200400403404409
POST
/api/publicapi/v1/transactions/{transactionId}/start
Starts the transaction
StartTransaction 1 param → 200400403404
POST
/api/publicapi/v1/transactions/{transactionId}/mobileInputLink
Generates link to run mobile input with one time auth token to inject image to specific transaction
GenerateMobileInputLink 1 param → 200400403404
POST
/api/publicapi/v1/transactions/launch
Starts processing of the files in new transaction
LaunchTransaction 1 param body → 201400404
GET
/api/publicapi/v1/transactions/{transactionId}
Gets transaction info
GetTransactionInfo 1 param → 200403404
DELETE
/api/publicapi/v1/transactions/{transactionId}
Deletes the transaction
DeleteTransaction 1 param → 200403404
GET
/api/publicapi/v1/transactions/{transactionId}/files/{fileId}/download
Downloads the result files
DownloadFile 2 params → 200403404
GET
/api/publicapi/v1/transactions/{transactionId}/registrationParameters
Gets registration parameters for the transaction
GetTransactionRegistrationParameters 1 param → 200400403404
GET
/api/publicapi/v1/transactions/{transactionId}/skillParameters
Gets the skill parameters that are set for the transaction
GetTransactionSkillParameters 1 param → 200400403404
GET
/api/publicapi/v1/transactions/active
Returns active transactions with specified parameters
GetActiveTransactions 10 params → 200400
GET
/api/publicapi/v1/transactions/completed
Returns completed transactions with specified parameters
GetCompletedTransactions 9 params → 200400

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are Abbyy.Vantage.PublicApi.Contract.Skills.Results.SkillDto (6 properties), Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionDto (6 properties), Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.ReindexOperationResult (6 properties), Abbyy.Vantage.PublicApi.Contract.Skills.Results.FieldDto (5 properties). Each schema is shown below with its type and property counts.

Abbyy.Vantage.PublicApi.Contract.Catalogs.ColumnType
string
Abbyy.Vantage.PublicApi.Contract.Catalogs.ReindexState
string
Abbyy.Vantage.PublicApi.Contract.Catalogs.Requests.RecordModel
object
2 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.AddRecordsResultResult
object
2 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogDto
object
4 properties 4 required
Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogListItemDto
object
2 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.ColumnDto
object
3 properties 3 required
Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.RecordDto
object
2 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.ReindexOperationResult
object
6 properties
Abbyy.Vantage.PublicApi.Contract.FieldType
string
Abbyy.Vantage.PublicApi.Contract.Invites.Requests.CreateAdminInviteData
object
See CreateAdminInviteData model.
5 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Skills.Results.FieldDto
object
5 properties
Abbyy.Vantage.PublicApi.Contract.Skills.Results.InnerSkillDto
object
1 property
Abbyy.Vantage.PublicApi.Contract.Skills.Results.SkillClassDto
object
2 properties
Abbyy.Vantage.PublicApi.Contract.Skills.Results.SkillDto
object
6 properties
Abbyy.Vantage.PublicApi.Contract.Skills.Results.SkillListItemDto
object
3 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Skills.SkillType
string
Abbyy.Vantage.PublicApi.Contract.Skills.TextFieldFormat
string
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.CompletedTransactionStatus
string
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.ImageProcessingOptions
object
Image preprocessing settings for import
2 properties
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.Parameter
object
2 properties
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.PreprocessingOperationSwitcher
string
Switcher of image preprocessing operations
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.StageType
string
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionCreateRequest
object
Transaction creation parameters
4 properties 1 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionDocumentCreateRequest
object
2 properties
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionDocumentFileMetadataDto
object
Additional file processing parameters
2 properties
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionDocumentMetadataDto
object
Additional processing parameters for transaction document. See TransactionDocumentMetadataDto model.
1 property
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionFileMetadataDto
object
Additional file processing parameters
3 properties
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionFileRegistrationParameter
object
2 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionLaunchMetadataDto
object
Additional transaction processing parameters. See TransactionLaunchMetadataDto model.
3 properties
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionMetadataDto
object
Additional transaction processing parameters. See TransactionMetadataDto model.
1 property
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionRegistrationParameter
object
Transaction registration parameter
2 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionSkillParameter
object
Skill parameter for transaction
2 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Transactions.ResultFileType
string
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.ClassDto
object
2 properties
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.ClassificationConfidenceDto
object
3 properties 3 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.ClassificationDto
object
3 properties 3 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.CreatedTransactionResult
object
1 property 1 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.DocumentBusinessRulesErrorDto
object
4 properties 3 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.ExtractedDocumentDto
object
4 properties 1 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.FileDto
object
2 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.MobileInputLinkResult
object
Result of link generation
2 properties 1 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.NewTransactionDocumentResult
object
1 property 1 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.NewTransactionResult
object
2 properties 1 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.ResultFileDto
object
3 properties 3 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.SkillParameterType
string
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionDocumentResult
object
2 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionDto
object
6 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionRegistrationParameterDto
object
Transaction registration parameter
2 properties
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionSkillParameterDto
object
Transaction skill parameter
3 properties
Abbyy.Vantage.PublicApi.Contract.Transactions.TransactionStatus
string
Microsoft.AspNetCore.Mvc.ProblemDetails
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

abbyy-vantage-processing-openapi.yml Raw ↑

Other APIs ABBYY publishes across the network.

ABBYY Vantage Reporting API
ABBYY FlexiCapture Cloud for Invoices API
ABBYY Documentation MCP Server
Where this information came from

This is an independent, third-party profile of ABBYY Vantage Processing REST API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.