Document Scanning & Image Capture

  • Published on Nov 10, 2025
  • 1 minute(s) read
Prev Next

Overview

With document scanning and image capture drivers can scan documents, capture images and import images with the mobile app. These documents and images are then made available for retrieval via App Manager or API, enabling integration with your document management or other backend systems.

How it works

Within the mobile app, documents can be scanned and images captured via Custom Screens, Dashboard Info cards, Forms, Load and Stop workflow Actions, Menus, To Dos.

There are two ways to retrieve documents and images:

  1. Document Hub within App Manager

  2. Document API: The system places documents and images in a queue for download.

Document Hub within App Manager

Document Hub enables you to search for documents by document type, date, or user. Individual documents can then be viewed, downloaded, or shared via email.

Document API

Document API enables you to automate the download of documents and images by polling a queue endpoint and marking them as downloaded once successfully retrieved.

The retrieval process workflow is as follows:

  1. Call the endpoint with your API key

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

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

  4. Repeat the process to retrieve the next document

Image Enhancement

Documents and images are enhanced based on type, which is configured within App Manager:

  • Black and white documents and images are enhanced to improve quality and clarity

  • Color images are not enhanced

IMPORTANT: If your Document Management System (DMS) also enhances documents this can cause issues with the image quality. If you are unable to turn image enhancement off in your DMS, we recommend capturing images in color as a workaround.

File Formats

Documents downloaded directly from the Document Hub are always formatted as a PDF.

When retrieving documents through the API or downloader script you can configure different formats to suit your imaging system. File format configuration is managed in App Manager > App Configuration > Document Types:

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

  • Metadata File: Document metadata, such as username, load number, and other data from the document scanning form, will be included in the selected format

Document Retention

Documents are typically retained for 90 days.

Resources