Skip to main content
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 certain parameters.

​
iOS platform

The iOS micro application of Vantage Mobile Input uses the following API calls:
  1. Sending parameters of the input session to the Vantage Mobile Upload Backend
  2. Getting parameters of the input session from the Vantage Mobile Upload Backend
  3. Getting status of the transaction
  4. Downloading models for analyzing images of the documents
  5. Getting list of the documents in the transaction
  6. Deleting existing documents in the transaction
  7. Creating a document in the transaction
  8. Uploading captured images to the document
  9. Starting the transaction

​
Android platform

The Android micro application of Vantage Mobile Input uses the following API calls:
  1. Getting status of the transaction
  2. Downloading models for analyzing images of the documents
  3. Getting list of the documents in the transaction
  4. Deleting existing documents in the transaction
  5. Creating a document in the transaction
  6. Uploading captured images to the document
  7. Starting the transaction

​
Sending input session parameters to the Vantage Mobile Upload Backend

To record when the user starts capturing documents and from which device, use POST /api/mobileinputbackend/v1/inputsessions. This resource accepts the following parameters:

​
Input session parameters

ParameterTypeDescription
transactionIdstring (uuid)Required. Transaction identifier specified in the mobile upload link.
platformstringRequired. The mobile platform of the device where the micro application is opened. Possible values: iOS, Android, Web.
deviceModelstringOptional. The model of the device where the micro application is opened.
OSVersionstringOptional. The OS version of the device where the micro application is opened.
MIVersionstringOptional. The Vantage Mobile Input version opened by the device.

​
Getting input session parameters from Vantage Mobile Upload Backend

To check when the user started capturing documents, use GET /api/mobileinputbackend/v1/inputsessions/{transactionId}. This resource returns the following parameters:

​
Input session parameters

ParameterTypeDescription
transactionIdstring (uuid)Transaction identifier specified in the mobile upload link.
platformstringThe mobile platform of the device where the micro application is opened. Possible values: iOS, Android, Web.
deviceModelstringThe model of the device where the micro application is opened.
OSVersionstringThe OS version of the device where the micro application is opened.
MIVersionstringThe Vantage Mobile Input version opened by the device.
createdAtstring (date-time)The date and time when the input session was created.

​
Getting the status of the transaction

To check the current status of the transaction when capturing and uploading documents, use GET /api/publicapi/v1/transactions/{transactionId}. This resource returns information about the transaction, including:
  • transactionId. The unique identifier of the transaction
  • status. Current transaction status (New, Queued, InProgress, Processed, etc.)
  • createdAt. When the transaction was created
  • documents. Array of documents in the transaction

​
Downloading the models for analyzing images of the documents

To download machine learning models that analyze document images for quality and type detection, use GET /api/mobileinputbackend/v1/models. This endpoint provides models that help the mobile app:
  • Detect document boundaries
  • Check image quality
  • Identify document types
  • Validate captured images

​
Getting a list of the documents in the transaction

To retrieve all documents currently associated with the transaction, use GET /api/publicapi/v1/transactions/{transactionId}/documents. This resource returns an array of document objects, each containing:
  • id. Document identifier
  • name. Document name
  • status. Document processing status
  • files. Array of files (images) associated with the document

​
Deleting existing documents in the transaction

To remove a document from the transaction before starting processing, use DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}. This allows users to:
  • Remove incorrectly captured documents
  • Clear documents before re-capturing
  • Manage document sets in the transaction
Note: Documents can only be deleted before the transaction starts processing.

​
Creating a document in the transaction

To create a new document in the transaction for uploading images, use POST /api/publicapi/v1/transactions/{transactionId}/documents. Request body example: 
{
  "documents": [
    {
      "name": "Invoice",
      "index": 0
    }
  ]
}
This returns a document ID that will be used for uploading images.

​
Uploading captured images to the document

To upload captured images to a specific document, use POST /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles. The request must include:
  • Form data with the image file(s)
  • Optional metadata about each file
  • Image processing options (autoCrop, autoOrientation)
Request format: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Files=@image1.jpg;type=image/jpeg" \
-F "Files=@image2.jpg;type=image/jpeg"

​
Starting the transaction

To begin processing all uploaded documents in the transaction, use POST /api/publicapi/v1/transactions/{transactionId}/start. This initiates the processing workflow with the skill specified when the transaction was created. Request example: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/start" \
-H "Authorization: Bearer token"
After starting:
  • The transaction status changes to Queued or InProgress
  • Documents are processed according to the configured skill
  • Results become available when status reaches Processed
  • You can track progress using the transaction status endpoint