API Reference

ABBYY FlexiCapture for Invoices Cloud API is organized around REST. The API enables you to access ABBYY FlexiCapture Cloud service resources. After you have registered and obtained the authentication header, you can make requests to the ABBYY FlexiCapture for Invoices Cloud API. The API uses built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. The ABBYY FlexiCapture Cloud web portal includes the API scheme in swagger format. You can use it to generate client code in the language that you use for your project with special tools, for example Swagger Editor.

API endpoint

https://api-{location-id}.flexicapture.com

Replace {location-id} with one of the supported locations:

us: USA and Canada
au: Australia
eu: The European Union countries

REST resources

The endpoint paths below are relative to the API endpoint described above.

v2.file

Method	Endpoint	Description
Upload	`POST /v2/file`	Upload one or more files to the cloud.
Download	`GET /v2/file/{id}/{token}`	Download a file from the cloud.
Get	`GET /v2/file/{id}/{token}/info`	Returns file metadata.
Delete	`DELETE /v2/file/{id}/{token}`	Delete a file from the cloud.

v2.task

Method	Endpoint	Description
Run	`POST /v2/task/capture/invoices`	Run an invoice capture task.
Get	`GET /v2/task/{id}`	Get task information by task ID.
Delete	`DELETE /v2/task/{id}`	Delete task data by task ID.

v2.dataset

Method	Endpoint	Description
Create business unit	`POST /v2/dataset/businessunits`	Create a list of business units.
Update business unit	`PUT /v2/dataset/businessunits`	Update information about business units in the dataset.
Get business unit	`GET /v2/dataset/businessunits/{region}`	Returns a list of business units according to the specified region.
Remove business unit by region	`DELETE /v2/dataset/businessunits/{region}`	Removes business units with the specified region from the dataset.
Remove business unit by ID	`DELETE /v2/dataset/businessunit/{region}/{externalId}`	Removes a business unit with the specified external ID from the dataset.
Create vendor	`POST /v2/dataset/vendors`	Create a list of vendors.
Update vendor	`PUT /v2/dataset/vendors`	Update information about vendors in the dataset.
Get vendor	`GET /v2/dataset/vendors/{region}`	Returns a list of vendors according to the specified region.
Remove vendor by region	`DELETE /v2/dataset/vendors/{region}`	Removes vendors with the specified region from the dataset.
Remove vendor by ID	`DELETE /v2/dataset/vendor/{region}/{externalId}/{businessUnitId}`	Removes a vendor with the specified external ID from the dataset.

v2.training

Method	Endpoint	Description
Train	`POST /v2/training`	Train a data capture model.
Layout	`GET /v2/training/layout/{taskId}/{fileId}`	Get captured data layout.

Administrator's Guide

Administration Guide

Performance Guide

Troubleshooting

Cloud

API endpoint

REST resources

v2.file

v2.task

v2.dataset

v2.training

​API endpoint

​REST resources

​v2.file

​v2.task

​v2.dataset

​v2.training

API endpoint

REST resources

v2.file

v2.task

v2.dataset

v2.training