Document Scanning & Image Capture

Prev Next

Overview

With document scanning and image capture, users can scan documents, capture images, and import images using the mobile app. The mobile app automatically enhances and processes scanned documents, then makes the documents available for retrieval via App Manager or the Documents API, enabling integration with document management systems or backend systems.

How It Works

The mobile app provides two primary scanning options: Inline Form Scan and Scan Flow. Users can scan documents and capture images via Menus, Custom Screens, Actions and To Do’s.

Scan Methods

Auto Scan & Enhanced Image Preview:

Available in version 1.62+ autoscan automatically detects and captures documents when they are properly positioned, reducing manual effort and improving scan consistency and automatic document cropping.

Additionally, we’ve added mobile-side image enhancement. Users can preview their scanned documents exactly as they’ll appear, before hitting send.

NOTE: Reach out to support@eleostech.com to have Auto Scan enabled.

Inline Form Scan

Inline Form Scan embeds document capture within a form and delivers a link to the document and form metadata to your Messaging web service.

  • Configuration: Configure an Inline Form Scan by adding a FORM-SCAN field to an action in App Manager or by using the Forms API.

  • Delivery: When submitting a form with a FORM-SCAN field, the platform typically delivers the form data twice. Each message includes a status property indicating the processing state of the document (e.g., PROCESSING, READY). The first delivery occurs when the mobile device submits the form (status: PROCESSING). The second delivery occurs when the platform finishes processing the document (status: READY). Integrations can safely ignore deliveries when the status is PROCESSING .

  • Offline Behavior: If the device is offline, the mobile app stores both the form data and the document until connectivity restores, and then delivers the items in the original sequence.

  • Duplicate Handling: Your Messaging service may receive the READY status multiple times even after the platform delivers a fully processed document. Store the document handle to ensure subsequent deliveries do not create duplicate records.

  • Photograph Support in Forms: When used with mobile app versions 1.62+ with Auto Scan enabled, Inline Form Scan supports capturing documents, which we enhance in black and white, and photographs which we do not enhance and arrive in full color. In earlier versions, or with Auto Scan disabled, Inline Form Scan supports documents only and does not support photographs.

NOTE: Documents scanned via Inline Form Scan are not sent to the Document Hub’s review queue.

The following example shows form data delivered while the document is still processing:

{
  "DOCUMENT-NUMBER": "10123679",
  "FORM-SCAN": {
    "status": "PROCESSING"
  },
  "TIME-FIELD": "2025-12-16T17:49:00+00:00",
  "Location": {
    "longitude": -82.79117423,
    "latitude": 34.70965876
  }
}

In this example, a document has been successfully processed and is ready to be viewed in the Document Hub or downloaded via the download_url field.  The download_url downloads a file containing the document in the configured file format and the associated metadata file.

{
  "DOCUMENT-NUMBER": "10123679",
  "FORM-SCAN": {
    "status": "READY",
    "pages": [
      {
        "quality": 0.7982792854309082
      }
    ],
    "download_url": "https://example-download-link.com",
    "document_hub_url": "https://example-hub-link.com"
  },
  "TIME-FIELD": "2025-12-16T17:49:00+00:00",
  "Location": {
    "longitude": -82.79115223,
    "latitude": 34.70966265
  }
}

Scan Flow

Scan Flow provides standalone document and photo capture from multiple locations in the app, independent of other form submission.

  • Configuration: Enable document scanning or photo capture by configuring an action or menu item with the type "Document Scan".

  • Delivery: Documents become available immediately in the Document Hub and via the Documents API. The Platform does not deliver form data to the Messaging endpoint.

  • Metadata Forms: If a Scan Flow action includes a form, the Platform attaches the form responses to the document as metadata.

NOTE: Integrations must retrieve the metadata via the Documents API rather than through the Messaging endpoint.

IMPORTANT: Scan Flow actions do not support the FORM-SCAN field type.

Image Enhancement and Supported Formats

The Platform enhances documents and images based on type, configured within App Manager.

  • Black and white documents and images receive enhancement to improve quality and clarity. You can optionally view original images in the Document Hub.

  • Color images do not receive enhancement.

IMPORTANT: If your Document Management System (DMS) also enhances documents, the dual enhancement can cause issues with image quality. If disabling image enhancement in the DMS is impossible, capture images in color as a workaround.

Document Retrieval

Retrieve documents using the Document Hub, the downloader script, or the Documents API.

The Document Hub within App Manager, enables administrators to search for documents by document type, date, or user. You can view, download, or share individual documents via email.

NOTE: When downloading a document directly from the Document Hub, the system always formats the file as a PDF.

Document API

The Document API enables download of documents and images by polling a queue endpoint and marking items as downloaded once successfully retrieved. The retrieval workflow is as follows:

  1. Call the GET Next Document endpoint with a valid API key.

  2. If documents are available, download the document using either the direct redirect or the download_url from the JSON response.

  3. Send a DELETE request to mark the document as downloaded and remove it from the queue.

  4. Repeat the process to retrieve the next document.

Downloader Script

To automatically retrieve every document or photograph from an account as the files become available, utilize our open-source PowerShell script. PowerShell is available for Windows, macOS, and Linux. Ensure PowerShell version 5 or newer is installed.

To switch to the new downloader script:

  1. Ensure PowerShell version 5 or newer is installed.

  2. If using an older version of Windows, follow Microsoft instructions to enable modern TLS protocols.

  3. Download the latest version of the downloader script.

  4. Follow the instructions in the README.txt included in the download.

File Formats for API and Script

When retrieving documents through the API or downloader script, App Manager users can configure different formats to suit the imaging system. Manage file format configuration by navigating to the API Integration File Formats section within App Manager > App Configuration > Document Types:

  • Document Format: Select separate file formats for black and white documents and full color images.

  • Metadata File: Receive an additional file containing document metadata, such as username, load number, and form data. For new integrations, utilize the metadata available in the GET next document endpoint directly rather than parsing data from the metadata file.

Document Retention

Platform Customers

Documents are retained for 90 days in both the Document Hub and through the API

Drive Axle Customers

Under our free Drive Axle plan, documents are retained for 365 days. Documents are retained indefinitely in the Document Hub for subscribed Drive Axle customers.

NOTE: For Platinum accounts only, documents are available through the Documents API for 90 days.

Resources

API

App Manager