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 Transactions API

The Transactions API from ABBYY — 11 operation(s) for transactions.

ABBYY Transactions API is one of 10 APIs that ABBYY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transaction. 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 12 operations across 11 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, 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.

12 operations 11 paths 27 schemas 1 DELETE6 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

ABBYY Transactions 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 12

Across 11 paths, the API surfaces 12 operations — 1 DELETE, 6 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

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…
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 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionDto (6 properties), Microsoft.AspNetCore.Mvc.ProblemDetails (5 properties), Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionCreateRequest (4 properties), Abbyy.Vantage.PublicApi.Contract.Transactions.Results.ExtractedDocumentDto (4 properties). Each schema is shown below with its type and property counts.

Abbyy.Vantage.PublicApi.Contract.Transactions.Results.FileDto
object
2 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.SkillParameterType
string
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.ClassDto
object
2 properties
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.NewTransactionResult
object
2 properties 1 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionCreateRequest
object
Transaction creation parameters
4 properties 1 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.PreprocessingOperationSwitcher
string
Switcher of image preprocessing operations
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.MobileInputLinkResult
object
Result of link generation
2 properties 1 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionSkillParameterDto
object
Transaction skill parameter
3 properties
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionSkillParameter
object
Skill parameter for transaction
2 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.ClassificationConfidenceDto
object
3 properties 3 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionDto
object
6 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionFileRegistrationParameter
object
2 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionRegistrationParameter
object
Transaction registration parameter
2 properties 2 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.ResultFileDto
object
3 properties 3 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionRegistrationParameterDto
object
Transaction registration parameter
2 properties
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.ImageProcessingOptions
object
Image preprocessing settings for import
2 properties
Microsoft.AspNetCore.Mvc.ProblemDetails
object
5 properties
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.ExtractedDocumentDto
object
4 properties 1 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.StageType
string
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.Parameter
object
2 properties
Abbyy.Vantage.PublicApi.Contract.Transactions.ResultFileType
string
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.CompletedTransactionStatus
string
Abbyy.Vantage.PublicApi.Contract.Transactions.TransactionStatus
string
Abbyy.Vantage.PublicApi.Contract.Transactions.Results.DocumentBusinessRulesErrorDto
object
4 properties 3 required
Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionFileMetadataDto
object
Additional file processing parameters
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

abbyy-transactions-api-openapi.yml Raw ↑

Other APIs ABBYY publishes across the network.

ABBYY FlexiCapture Cloud for Invoices API
ABBYY Documentation MCP Server
ABBYY Catalog Records API
ABBYY Catalogs API
ABBYY Invites API
ABBYY Report API
ABBYY Report v1 API
ABBYY Skills API
ABBYY Transaction Documents API
Where this information came from

This is an independent, third-party profile of ABBYY Transactions 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.