Skip to main content

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.

Package Variants​

Important: This SDK is distributed in two separate packages:

Development Package​

  • For: Local development, debugging, and testing
  • Filename: gbgplc-smartcapture-web-development-vX.Y.Z.tgz
  • DevTools: Enabled - Full debugging capabilities
  • ⚠️ For development environments only

Production Package​

  • For: Production deployments
  • Filename: gbgplc-smartcapture-web-production-vX.Y.Z.tgz
  • Optimizations: Enabled - Production-ready build
  • ✅ Required for production environments

The package variant is determined at build time by which package you install. All dependencies load automatically from the bundle.

Which package should I use?

  • Use Development for local development only
  • Use Production for standard production deployments

For complete details, see:

Installation​

Prerequisites​

You will need:

  • The gbgplc-smartcapture-web-vX.Y.Z.zip file
  • The password to extract it

Steps​

  1. 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

  2. Locate the .tar file

Move gbgplc-smartcapture-web-vX.Y.Z.tar to your project root.

  1. 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: