Data processed by Vantage Mobile Upload
Vantage Mobile Upload communicates with the Vantage server by using API calls. These calls are used to create documents, upload images, and start processing transactions with ABBYY Vantage skills.
The Vantage Mobile Upload operation scenario depends on the platform on which it is launched.
iOS platform
When opening the mobile input link on an iOS device, Vantage Mobile Upload goes through the following steps:
- Starting the upload session.
- Getting the status of the transaction.
- Downloading the models for analyzing images of the documents.
- Getting a list of the documents in the transaction.
- Deleting existing documents in the transaction.
- Creating a document in the transaction.
- Uploading captured images to the document.
- Starting the transaction.
Android platform
When opening the mobile input link on an Android device, Vantage Mobile Upload goes through the following steps:
- Sending input session parameters to Vantage Mobile Upload Backend.
- Getting input session parameters from Vantage Mobile Upload Backend.
- Starting the upload session.
- Getting the status of the transaction.
- Getting a list of the documents in the transaction.
- Deleting existing documents in the transaction.
- Creating a document in the transaction.
- Uploading captured images to the document.
- Starting the transaction.
When starting the mobile upload session in a web browser, Vantage Mobile Upload follows a platform-specific scenario based on whether it has been started on an iOS device or on an Android device.
Sending input session parameters to the Vantage Mobile Upload Backend
Vantage Mobile Input sends input session parameters to the Vantage Mobile Upload Backend. These parameters are used for the upload session in the Android micro application or in the web browser.
Input session parameters
Key | Description |
---|---|
BaseURL | The main domain of Vantage server. |
TransactionID | The identifier of the transaction. |
Token | The encoded authorization access token that is used for authorized access to the Vantage API. |
v | The version of the Vantage API. |
md | The quantity of the documents that will be captured in one transaction. |
redirect_uri | The redirect link that opens once Vantage Mobile Upload is finished. |
dt | The document type. |
ma | The ABBYY Vantage cloud environment address that is used to start micro applications for on-premises installations. |
Request
Response
Getting input session parameters from Vantage Mobile Upload Backend
To get the input session parameters, Vantage Mobile Upload sends requests to Vantage Mobile Upload Backend.
Input session parameters
Key | Description |
---|---|
BaseURL | The main domain of Vantage server. |
TransactionID | The identifier of the transaction. |
Token | The encoded authorization access token that is used for authorized access to the Vantage API. |
v | The version of the Vantage API. |
md | The quantity of the documents that will be captured in one transaction. |
redirect_uri | The redirect link that opens once Vantage Mobile Upload is finished. |
dt | The document type. |
ma | The ABBYY Vantage cloud environment address that is used to start micro applications for on-premises installations. |
Request
Response
Sample of input session parameters
Getting the status of the transaction
Vantage Mobile Upload sends a request to get the transaction identifier and status. Only transactions with the New status are valid for uploading documents.
Key parameters
Key | Description |
---|---|
TransactionID | The identifier of the transaction. |
Status | The status of the transaction. Possible values: New, Started, Processing, Processed |
Request
Response
Downloading the models for analyzing images of the documents
Vantage Mobile Upload sends requests to download models for detecting page edges on the images of the documents for the iOS micro application.
Key parameters
Key | Description |
---|---|
AbbyyRtrSDK-version | The version of AbbyyRtrSDK framework used to request the relevant pattern files. The value may change depending on the version of Vantage. |
PatternFileName |
The name of the AbbyyRtrSDK file pattern that is used for detecting page edges on the images of the documents. There are six types of file patterns:
|
Request
Response
Getting a list of the documents in the transaction
Before uploading documents to the transaction, Vantage Mobile Upload sends a request to check the transaction for previously created documents. If the transaction is not empty, Vantage Mobile Upload sends Delete document request to delete all existing documents before a new upload session.
Key parameters
Key | Description |
---|---|
TransactionID | The identifier of the transaction. |
DocumentID | The identifier of the document received from the Creating a document request. |
SourceFileID | The identifier of the document image. |
SourceFileName | The name of the document image. Vantage Mobile Upload automatically generates file names for each image and uploads images to the document using theUploading Images to the documentrequest. |
Request
Response
Deleting existing documents in the transaction
Before creating a new document in the transaction, Vantage Mobile Upload sends a request to delete all previously created documents.
Key parameters
Key | Description |
---|---|
TransactionID | The identifier of the transaction. |
DocumentID | The identifier of the document received from the Creating a document request. |
Request
Response
Creating a document in the transaction
To upload images Vantage Mobile Upload sends a request to create document instances for each document in the transaction.
Key parameters
Key | Description |
---|---|
Token | The encoded authorization access token that is used for authorized access to the Vantage API. |
TransactionID | The identifier of the transaction. |
DocumentID | The identifier of the document. |
Request
Response
Uploading captured images to the document
Once the document instance has been created, Vantage Mobile Upload sends a request to upload all the images to the document. All images for one document are uploaded in a single request.
Key parameters
Key | Description |
---|---|
Token | The encoded authorization access token that is used for authorized access to the Vantage API. |
TransactionID | The identifier of the transaction. |
DocumentID | The identifier of the document received from the Creating a document request. |
SourceFileID | The identifier of the document image. |
SourceFileName | The name of the document image. Vantage Mobile Upload automatically generates file names for each image and uploads images to the document. |
ImageData | The encoded information from the image files. Used to upload images to documents. |
Request
Response
Starting the transaction
Once all the documents have been created and all the images have been uploaded to the documents, Vantage Mobile Upload sends a request to start the transaction.
Key parameters
Key | Description |
---|---|
Token | The encoded authorization access token that is used for authorized access to the Vantage API. |
TransactionID | The identifier of the transaction. |
Request
Response
22.12.2023 12:36:42