Skip to content

Getting Started

The Document Reader web components let you add document verification to your web site. The components can capture a document from the device camera or process an uploaded image, crop the image by the document boundaries, detect the presence or absence of the machine readable zone (MRZ) and return the MRZ text fields.

The Document Reader web components package contains:

The UI web components are:

  • document-reader for documents recognition.
  • camera-snapshot for capturing images from a camera or uploading from a gallery.

Before You Start

Please note that:

  • The components work only under the HTTPS protocol on the web site.
  • The components library does register the components on the web page itself, so make sure to import the library to your web site before adding the components to the web page code.
  • The UI components and the SDK use the getUserMedia method to display the video stream from the camera. This feature is available only in secure contexts (HTTPS).

Note

The uploaded image of a document must meet the Image Quality Requirements, otherwise, the processing may not be completed.

Compatibility

Devices

Mobile (iOS) 99 99 11
Mobile (Android) 66 61
Desktop 61 60 11

Examples

Find examples of using the components on the Samples page.

Licensing

To get a license, reach our sales team.

❗ To use the web components on test environments, set the base64 license value to the license attribute: <document-reader license="BASE64_LICENSE_KEY"></document-reader>.

More information on licensing: Domain name licensing

Additional Resources