SmartCapture Web SDK
The SmartCapture Web SDK provides a set of tools and components for capturing identity documents and face images directly in the browser. It is designed for seamless integration, real-time feedback, and a smooth user experience.
Summary
This SDK includes:
- Document Camera: Detects and captures identity documents with real-time analysis and user guidance.
- Face Camera: Detects and captures face images with automated capture and live feedback.
- Low-Code Integration: Components are implemented as custom HTML elements.
- TypeScript Support: Full type definitions for all objects and functions.
- NPM Distribution: Delivered as a password-protected
.zip
file containing a.tar
package.
Installation
Prerequisites
You will need:
- The
gbgplc-smartcapture-web-vX.Y.Z.zip
file - The password to extract it
Steps
-
Extract the ZIP file
Use the terminal to extract the archive:
unzip path/to/gbgplc-smartcapture-web-vX.Y.Z.zip -d path/to/output
-
Locate the .tar file
Move gbgplc-smartcapture-web-vX.Y.Z.tar to your project root.
- Install the SDK
Note: Replace vX.Y.Z with the actual version number (e.g., v1.2.3).
Documentation
The following sections provide detailed guidance:
- Quick Integration: Basic setup for both camera components.
- Document Camera Component: Parameters, events, and usage.
- Face Camera Component: Configuration and event handling.
- FAQ: Common questions and troubleshooting.