DocumentScanner API

Scan documents from a Lightning web component.

The Syntax sections in the following topics use TypeScript formatting. We use this formatting to make the API syntax easier to understand. For example, functions can be described by the function name, parameter name and type, and a return type like this.

Optional parameters are appended with ? like objectInfo?: ObjectInfo. For more information, see the TypeScript Handbook.

TypeScript support is in developer preview. We're working on adding type definitions for components and modules in the lightning namespace.

For more information about how DocumentScanner works, see Scan Documents on a Mobile Device.