Mobile SDK HTML5 SDK Developer's Guide Version: 3.5.0 Date: 2019-08-01 © 2019 Kofax. All rights reserved. Kofax is a trademark of Kofax, Inc., registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Kofax. Table of Contents Preface.......................................................................................................................................................... 5 Getting help with Kofax products.......................................................................................................5 Product documentation.......................................................................................................................5 Default online documentation.................................................................................................. 6 Configure offline documentation..............................................................................................6 Chapter 1: About the HTML5 SDK............................................................................................................ 7 Introduction......................................................................................................................................... 7 HTML5 Capture.................................................................................................................................. 7 HTML5 Selfie Capture......................................................................................................................10 HTML5 setup.................................................................................................................................... 10 Capture images......................................................................................................................10 User recommendations for taking a photograph...................................................................10 HTML5 extraction setup................................................................................................................... 11 WeChat requirements.......................................................................................................................11 Setting up the prerequisites............................................................................................................. 12 Using the HTML5 SDK with other HTML5 applications...................................................................12 HTML5 SDK external classes.......................................................................................................... 13 KfxWebSDK.Capture (Kofax Capture)...................................................................................13 KfxWebSDK.SelfieCapture (Kofax Selfie Capture)............................................................... 17 KfxWebSDK.DocumentExtractor (Kofax DocumentExtractor)...............................................21 KfxWebSDK.ReviewControl (Kofax ReviewControl)............................................................ 24 KfxWebSDK image processor............................................................................................... 25 KfxWebSDK.Utilities (Kofax Utilities)....................................................................................27 KfxWebSDK.AppStats (Kofax AppStats )..............................................................................27 JSON definitions...............................................................................................................................29 General response structure................................................................................................... 29 Capture set options............................................................................................................... 38 Extraction Options..................................................................................................................39 On-boarding application....................................................................................................................39 Mobile ID................................................................................................................................39 Passport................................................................................................................................. 40 Check deposit........................................................................................................................ 40 Bill pay................................................................................................................................... 41 Credit card............................................................................................................................. 41 3 Mobile SDK HTML5 SDK Developer's Guide New Account..........................................................................................................................41 Support and limitations.....................................................................................................................41 Supported devices................................................................................................................. 41 Supported browsers...............................................................................................................43 Limitations in the SDK...........................................................................................................43 Verifying captured images................................................................................................................ 46 Installation and hosting guide.......................................................................................................... 46 Overview................................................................................................................................ 46 Creating a new Web application........................................................................................... 46 Adding the SDK to an existing web application....................................................................47 Coding examples for HTML5 SDK...................................................................................................47 Initiate SDK capture with default options.............................................................................. 47 Initiate SDK selfie capture with default options.....................................................................48 Extraction............................................................................................................................... 48 Use HTML5 SDK as a node package............................................................................................. 49 4 Preface This guide includes the information you need to successfully integrate HTML5 SDK components into your mobile project. For additional details on API library properties and settings, refer to the HTML5 SDK API Reference Guide. Getting help with Kofax products The Kofax Knowledge Base repository contains articles that are updated on a regular basis to keep you informed about Kofax products. We encourage you to use the Knowledge Base to obtain answers to your product questions. To access the Kofax Knowledge Base, go to the Kofax website and select Support on the home page. Note The Kofax Knowledge Base is optimized for use with Google Chrome, Mozilla Firefox or Microsoft Edge. The Kofax Knowledge Base provides: • Powerful search capabilities to help you quickly locate the information you need. Type your search terms or phrase into the Search box, and then click the search icon. • Product information, configuration details and documentation, including release news. Scroll through the Kofax Knowledge Base home page to locate a product family. Then click a product family name to view a list of related articles. Please note that some product families require a valid Kofax Portal login to view related articles. • Access to the Kofax Customer Portal (for eligible customers). Click the Customer Support link at the top of the page, and then click Log in to the Customer Portal. • Access to the Kofax Partner Portal (for eligible partners). Click the Partner Support link at the top of the page, and then click Log in to the Partner Portal. • Access to Kofax support commitments, lifecycle policies, electronic fulfillment details, and self-service tools. Scroll to the General Support section, click Support Details, and then select the appropriate tab. Product documentation By default, the Mobile SDK documentation is available online. However, if necessary, you can also download the documentation to use offline. 5 Mobile SDK HTML5 SDK Developer's Guide Default online documentation The product documentation for Mobile SDK 3.5.0 is available at the following location. https://docshield.kofax.com/Portal/Products/en_US/KMC/3.5.0-cs5i340uk7/SDK.htm Configure offline documentation To access the documentation offline, download KofaxMobileSDKDocumentation-3.5.0_EN.zip from the Kofax Fulfillment Site and extract it on a local drive available to your users. The compressed file includes both help and print folders. The print folder contains all guides, such as the Installation Guide and the Administrator's Guide. The help folder contains APIs and other references. 6 Chapter 1 About the HTML5 SDK Introduction