Uploading documents from a mobile device

You can add a mobile device upload feature to your application or web page. This feature allows capturing document images using the camera of a mobile device. Uploaded documents will be processed using ABBYY Vantage skills. The mobile device upload feature can be integrated into the following:

  • Native Android and iOS applications.
  • Mobile web applications.
  • Desktop applications.

For the system requirements for mobile devices and web browsers, see the Uploading Documents from a Mobile Device section in the Quick Start Guide.

Integration with applications is only possible via the Vantage API. For more information about using the Vantage API, see the Swagger documentation.

To add the mobile device upload feature, complete the following steps:

  1. Authenticate in ABBYY Vantage (see Authentication for detailed instructions).

Each HTTP request to ABBYY Vantage should have a header containing an access token which the service will use to identify user in the system.

  1. View the list of available skills and find the ID of the skill that you need to use to process documents.
    To do so, send a GET request to the skills resource:

GET https://vantage-eu.abbyy.com/api/publicapi/v1/skills for users in Western Europe,
GET https://vantage-us.abbyy.com/api/publicapi/v1/skills for users in North America, and

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

Run the following command:

For Windows

For Linux

  1. Create a transaction for the selected skill and get a mobile input link.
    To create transaction, send a POST request to the Transactions resource:

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

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

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

Run the following command:

For Windows

For Linux

In the examples above, skillId contains the ID of the skill obtained in step 2.

To get a mobile upload link, specify generateMobileInputLink: true parameter. You can configure the mobile upload link using additional parameters. For more information, see Configuring Mobile Upload.

The link will contain ABBYY Vantage access token and will be valid for 30 minutes, after which a new link should be obtained.

If you use QR codes or buttons for uploading documents on your website, we recommend that these QR codes and buttons create a new transaction and/or refresh the token every 30 minutes. Otherwise, users will not be able to upload documents after the initial token expires.

Instructions on how to take photos of documents and uploading documents from a mobile device are available in the Uploading Documents from a Mobile Device section of the Quick Start Guide.

22.12.2023 12:36:42

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.