Skip to main content

FAQ

Whose responsibility is it to make sure 3rd party dependencies are free from vulnerabilities?​

We want to clarify that while we provide our SmartCapture WebSDK with a vetted set of dependencies, customers have the discretion to extend functionality by introducing additional dependencies or using other versions that meet their specific requirements. This is beyond the control of GBG Plc, and we advise customers to conduct their own checks on any new dependencies introduced and take appropriate actions to manage any issues discovered.

Which file formats are supported for integration?​

The SDK is distributed as a .zip file containing a .tar package. After extraction, you can install the .tar package locally as an NPM dependency.

Which module systems are supported?​

We support all modern ESModules. This ensures compatibility with the latest JavaScript module standards that enable seamless integration in environments that support ESModules. The SDK currently targets ES6 and higher.

How do I handle updates to the SDK?​

Download the latest version of the gbgplc-smartcapture-web-vX.Y.Z.zip file and follow the installation steps to replace the existing .tar package in your project.

What are the minimum supported versions for the SDK in each of the platforms?​

  • Browser versions:
    Chrome desktop: v103
    Chrome (Android): v112
    Safari desktop: v15.1
    Safari (iOS): v15.0
    Edge: v103
    Firefox desktop: v103
    Firefox (Android): v110

  • OS requirements:
    iOS: 14 and later
    Android: 11 and later

I cannot get the tar file when I directly unzip the SDK file, what should I do?​

It must be done through the terminal, please read through this page in documentation (link to the homepage of the documentation) this page in documentation:

What should I do if I encounter installation issues?​

Ensure you are using the correct password to extract the gbgplc-smartcapture-web-vX.Y.Z.zip file. For installation issues, verify that your environment supports local dependencies installed from .tar files.

How do I capture the back side of a document with the Document Camera Component?​

To capture the back side of a document, set the isOpen property of the LiveDocumentCamera back to true. This will reinitialize the camera and allow for capturing the document's reverse side.

What is the environment attribute in the face camera component, and how should I use it?​

The environment attribute allows you to specify whether the face camera component should run in production or development mode.

  • Production (environment="production") (default): Uses the standard version of the camera component, with full security and performance optimizations.
  • Development (environment="development"): Enables additional debugging capabilities and relaxed injection protections. This mode is strictly for development purposes and should not be used in production environments.

Example usage:

<live-face-camera environment="development"></live-face-camera>

If the environment attribute is omitted, the component defaults to production mode.

Note:
In all references to vX.Y.Z, this represents the version number of the SDK you are integrating. For example, v1.2.3 would indicate version 1.2.3 of the SDK.