Configuring mobile upload
You can configure the mobile upload feature using the following additional parameters:
- The md parameter customizes the number and names of the documents, along with the pages for each document to be captured in one transaction.
- The dt parameter customizes mobile upload to capture identity documents.
- The redirect_uri parameter customizes a website link that will be opened once the mobile upload is finished.
You can specify the structure of the documents with the number, types, and names of documents that need to be processed in one transaction using the md parameter. Vantage mobile upload will guide users on how to accurately capture specified documents for further processing.
Screenshot demonstrating the document structure configured using the md parameter in the mobile upload
By default, the md parameter is present in the mobile upload link with a value of either 0 or 1, depending on the selected skill. You can specify one of the following values:
Value | Description |
---|---|
0 | Captures one document with any number of pages. |
1 | Captures any number of documents with any number of pages. |
Encoded URL to JSON file | Captures a specified number of documents with customized names, along with defined number and names of pages for each document. |
Encoded JSON file |
The JSON file for the md parameter is only available for mobile upload from micro applications.
Example of using the encoded URL to JSON file for the md parameter:
https://vantage-eu.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&md=https%3A%2F%2Fdomain.tld%2Fstructure.json&token=<token>&v=<2.4> (for users located in Western Europe), https://vantage-us.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&md=https%3A%2F%2Fdomain.tld%2Fstructure.json&token=<token>&v=<2.4> (for users located in North America), https://vantage-au.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&md=https%3A%2F%2Fdomain.tld%2Fstructure.json&token=<token>&v=<2.4> (for users located in Australia). |
Example of using the encoded JSON file for the md parameter:
https://vantage-eu.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&md=<encoded_json_structure>&token=<token>&v=<2.4> (for users located in Western Europe), https://vantage-us.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&md=<encoded_json_structure>&token=<token>&v=<2.4> (for users located in North America), https://vantage-au.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&md=<encoded_json_structure>&token=<token>&v=<2.4> (for users located in Australia). |
If the dt parameter is used in the mobile upload link, the value of the md parameter will be ignored.
To customize mobile upload to capture identity documents, use the dt parameter:
- Add the dt parameter to the mobile upload link.
- Specify one of the following values:
Value | Description |
---|---|
idcard | Captures both sides (front and back) of an ID card. |
passport | Captures the first page of a passport. |
document | Captures any other document. |
The dt parameter is optional and does not have a default value.
Using the dt parameter will adjust the camera in the micro application so that identity documents are captured automatically.
Example of using the dt parameter for capturing ID cards:
https://vantage-eu.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&token=<token>&v=<2.4>&dt=idcard (for users located in Western Europe), https://vantage-us.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&token=<token>&v=<2.4>&dt=idcard (for users located in North America), https://vantage-au.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&token=<token>&v=<2.4>&dt=idcard (for users located in Australia). |
Example of using the dt parameter for capturing a passport page:
https://vantage-eu.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&token=<token>&v=<2.4>&dt=passport(for users located in Western Europe), https://vantage-us.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&token=<token>&v=<2.4>&dt=passport(for users located in North America), https://vantage-au.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&token=<token>&v=<2.4>&dt=passport(for users located in Australia). |
When the dt parameter is used in the mobile upload link, only one document can be uploaded in a single transaction regardless of the selected skill.
To specify a URL to which the user will be redirected once the mobile upload is finished, use the redirect_uri parameter:
- Add the redirect_uri parameter to the mobile upload link.
- Specify your intended redirect URL as its value.
Example of using the redirect_uri parameter:
https://vantage-eu.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&token=<token>&v=<2.4>&redirect_uri=https%3A%2F%2Fyourwebsite.com(for users located in Western Europe), https://vantage-us.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&token=<token>&v=<2.4>&redirect_uri=https%3A%2F%2Fyourwebsite.com(for users located in North America), https://vantage-au.abbyy.com/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&token=<token>&v=<2.4>&redirect_uri=https%3A%2F%2Fyourwebsite.com(for users located in Australia). |
12/22/2023 12:36:42 PM