Skip to main content
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 a single document type.
  • The redirect_uri parameter customizes a website link that will be opened once the mobile upload is finished.
  • The ma parameter enables the use of micro applications for on-premises environments.

The md parameter

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 Input will guide users on how to accurately capture specified documents for further processing. 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:
ValueDescription
0Captures one document with any number of pages.
1Captures any number of documents with any number of pages.
Encoded URL to JSON fileCaptures a specified number of documents with customized names, along with defined number and names of pages for each document.
Encoded JSON fileCaptures a specified number of documents with customized names, along with defined number and names of pages for each document.
Note: 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://your-server/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&md=https%3A%2F%2Fdomain.tld%2Fstructure.json&token=<token>&v=<2.4>
Example of using the encoded JSON file for the md parameter:
https://your-server/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&md=<encoded_json_structure>&token=<token>&v=<2.4>
Note: If the dt parameter is used in the mobile upload link, the value of the md parameter will be ignored.

The dt parameter

To customize mobile upload to capture a single document type, use the dt parameter:
  1. Add the dt parameter to the mobile upload link.
  2. Specify one of the following values:
ValueDescription
idcardCaptures both sides (front and back) of an ID card.
passportCaptures the first page of a passport.
documentCaptures any other document.
Example of using the dt parameter:
https://your-server/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&dt=idcard&token=<token>&v=<2.4>
Note: If the dt parameter is used in the mobile upload link, the value of the md parameter will be ignored.

The redirect_uri parameter

You can customize a website link that will be opened once the mobile upload is finished and the transaction has started processing. This allows you to manage the user workflow after mobile upload is complete. To do so, add the redirect_uri parameter to the mobile upload link. Example of using the redirect_uri parameter:
https://your-server/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&redirect_uri=https%3A%2F%2Fwww.example.com&token=<token>&v=<2.4>
Note: When using the redirect_uri parameter, make sure you add the base URL (for example, https://www.example.com) of the website link to be opened in the Allowed redirect URLs section of the Tenant Settings. See Configuring Allowed Redirect URLs for more information.

The ma parameter

By default, the ma parameter is not present in the mobile upload link. To use micro applications for on-premises environments, add the ma parameter to the mobile upload link with the true value. Example of using the ma parameter:
https://your-server/mobile?baseUrl=<base URL>&transactionId=<transaction-id>&ma=true&token=<token>&v=<2.4>
Note: The ma parameter is not supported on cloud environments.