Tracking document processing and downloading results

You can track the status of your transaction and download the file containing the processing results.

Send a GET request to the transactions/<transaction-id> resource:

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id for users in Western Europe,

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id for users in North America, and

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id for users in Australia.

Run the following command:

For Windows

For Linux

Sample command results

The status key can have one of the following values:

  • Processing means that the document is currently being processed.
  • Processed means that processing has completed and the results can be downloaded.

To download a file containing the processing results, send a GET request to the transactions/<transaction-id>/files/<file-id>/download resource and specify the IDs of your transaction and document file:

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download for users in Western Europe,

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download for users in North America, and

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download for users in Australia.

The file ID can be found in the sourceFiles property in the results for the transaction status request.

Run the following command:

For Windows

For Linux

The command will return the document processing results in JSON format.

You can also download the results in PDF format. To do so, select the Output activity, click Settings in the Exported Data section in the Actions pane, and choose PDF as your preferred format.

12/22/2023 12:36:42 PM

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.