Document Capture Module

The Document Capture module captures generic documents (utility bills, lease agreements, tax documents, address proofs, vehicle logbooks, etc.) — anything that isn't an identity document but needs to be uploaded as part of verification. Supports both camera-based capture and file-picker upload, with optional multi-page support.

This module follows the camera-capture pattern, but extends it with file-upload alternatives and multi-page state.

Tag

<incode-document-capture> is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

import '@incodetech/web/document-capture';
import '@incodetech/web/document-capture/styles.css';

Properties

Configuration

type DocumentCaptureConfig = {
  processingType?: DocumentType; // Backend routing key (default 'addressStatement')
  captureMode?: 'file' | 'camera'; // 'camera' = capture only (hides upload); 'file' = upload only (hides camera); absent = capture + upload
  allowSkipDocumentCapture?: boolean; // Default false
  disableSkipPoa?: boolean; // Backend ADDRESS field; inverse of allowSkipDocumentCapture
  title?: string; // Tutorial screen title override
  text?: string; // Tutorial screen text override
  step2Title?: string; // Multi-page tutorial second-page title
  step2Text?: string; // Multi-page tutorial second-page text
  captureAttempts?: number; // Default 3
  sendBase64?: boolean; // Default false; OCR processing, v3 and CFDI endpoints always require base64 JSON
  maxFileSize?: number; // Default 10 MB
  onlyPdf?: boolean; // Default false. Restrict uploads to PDF; camera capture unaffected
};

processingType accepts: addressStatement, otherDocument1, otherDocument2, otherDocument3, v5cMultiPageLogbook, circulationCard, financeSettlement, carInvoice, w8Ben, w8BenE, plus process* variants for OCR-driven processing — including processW8BenOcr and processW8BenEOcr for the IRS W-8 tax forms. The multi-page types (v5cMultiPageLogbook, circulationCard, financeSettlement, w8BenE) trigger the nextPage flow described below. W-8BEN is single-page; W-8BEN-E is multi-page.

For address statements (addressStatement or capture) and generic documents (otherDocument1, otherDocument2, otherDocument3), sendBase64: false (the default) uploads raw file bytes to /omni/add/document with the file's MIME type as Content-Type. Setting sendBase64: true sends base64 JSON to their respective v2 endpoints.

OCR processing options processPoaOcr, processLoaOcr, processAsylumSeekerVisaZaf, processBankStatementOCR, processBankCheck, processIneMex, and processColombiaRutForm always use /omni/add/address-statement/v2 with the selected processing option as the type query parameter and a base64 JSON payload, regardless of sendBase64.

Types that use /omni/add/document/v3 or /omni/process/cfdi always send base64 JSON because those endpoints require it, regardless of sendBase64. These rules apply to camera captures, selected images, and PDFs.

Set onlyPdf: true when the document only makes sense as a PDF, such as a tax form the user downloads and re-uploads. It narrows the file picker and rejects non-PDF selections; it does not disable camera capture, so pair it with captureMode: 'file' for a PDF-only step.

State machine

DocumentCaptureState is a discriminated union over status. The states extend the camera-capture pattern with file-upload and multi-page handling:

State properties

Additional properties for custom capture controls:

In a headless camera UI, attach stream to your video element, capture a frame in your host, then pass its File and preview data URL to setFile(). In nextPage, choose a capture method before submitting another file. capture() does not pull a frame from capturing.

The shared permissionStatus type includes checking, idle, motionOnly, requesting, denied, and learnMore. Document Capture currently emits checking, idle, requesting, denied, and learnMore. Show no prompt while checking; show the request action in idle, a busy state in requesting, and permission instructions after denial.

API methods

Plus the universal lifecycle: subscribe, getState, stop.

Capture-method selection and help

When the step offers both camera and upload, the tutorial state lets the user choose between them, and the capturing state can show a "common issues" help overlay. Both are overlays over an existing state rather than states of their own, so each is driven by a boolean on the state you are already in:

Read methodSelectionOpen from the tutorial state and helpOpen from the capturing state to decide what to render. Both default to false, so an integration that ignores them keeps the previous behavior.

Camera and upload requirements

Camera capture requires a secure browser context (HTTPS in production) and camera permission. Users review the captured image or selected file before upload. Document Capture does not require warming up the ID Capture WASM pipeline. If your integration enables end-to-end encryption, follow that feature's setup requirements separately.

See also

• Module Patterns → camera-capture
• WASM Configuration
• Individual Modules