Overview

About this SDK

The Unico Check Web SDK enables you to quickly build a great experience in your applications. A component is provided to allow you to frictionlessly capture images in your application through the use of modern camera opening mechanisms as well as computer vision algorithms.

Apart from abstracting all the complexity related to any device-specific nuances, the SDK also helps to correctly frame the images, optimizing its capture, aiming to increase the accuracy in the response of the biometric engine.

Our SDK uses native HTML 5 resources, JavaScript and CSS. It works in all modern browsers.

Compatibility

Operational Systems

Our capture frame supports the following OS/Versions:

• iOS: iOS 11.0 or higher;
• Android: Android 5.1 or higher;

Our Web SDK is also compatible with Windows e MacOs.

WARNING

In Web Desktop version, users might have some issues with image capture or validation due to the image quality of some VGA cameras

Important

The application works on iFrames only when using Interactive Liveness. See more in the section CONFIGURE INTERACTIVE LIVENESS CAPTURE MODE IN IFRAME'S

Other capture modes do not work in iFrame.

Browsers

Our capture frame is compatible with the following browsers/OS:

Operational System	Chrome	Firefox	Safari	Samsung Internet	Opera	Edge
Windows (desktop)
Android		*
IOS
MacOS (desktop)

* Firefox support on Android

Firefox browser on Android is only supported by Smartlive without interaction

In general, Unico Check SDK supports WebRTC and newer versions of the browsers listed above. For compatibility and security reasons, we do not guarantee compatibility on very old versions of these browsers.

Webview

ABOUT THE TOOL

It is a system component that allows Android or iOS applications to display web content directly within the application, based on the same code project. Being responsible for browsing websites and web content within the applications.

BEFORE YOU BEGIN

You must have implemented the Web SDK in an application that contains a secure domain with https protocol.

COMPATIBILITY WITH SOCIAL NETWORKS

The component has been approved on social media: Instagram and Facebook in all capture modes (Except in Selfie camera FaceTec proof-of-life mode).

COMPATIBILITY WITH HYBRID FRAMEWORKS

The component was approved only in native layers, so that it can be used in hybrid frameworks (Flutter or React Native) it is necessary to implement it in the native layer of Android and/or iOS.

IMPORTANT

When running, the SDK will ask for permission to open the camera for the webview, which in turn will ask for the same permission for the native application. Please, ensure your native application has the necessary permissions set in the configuration files. More details on this point will be shown in the sections below.

ANDROID

COMPATIBILITY WITH OPERATING SYSTEM

The Web SDK supports webviews running on Android 8 (API 26) or higher.

DEVICE COMPATIBILITY

The tool is compatible with the vast majority of devices. The following table lists the devices tested in the laboratory. Some extensions listed may be subject to manufacturer-specific API levels or SKUs:

Device	S.O. version	Selfie Camera with Manual Capture	Smart Capture Selfie Camera	Document Camera with Manual Capture
Galaxy A12	Android 11.0
Galaxy A10s	Android 10.0
Galaxy S20FE	Android 12.0
Moto G8 Plus	Android 9.0
Moto G52	Android 12.0
Moto E7	Android 10.0
LG K62	Android 10.0
Asus X01BDA	Android 8.1.0

WARNING

The partner FaceTec guarantees the functioning of the webview. With this, the webview can also be used in Selfie camera FaceTec proof-of-life mode.

DEPLOYMENT

For the SDK to work correctly, it is necessary to add some permissions and settings to the AndroidManifest file, they are:

AndroidManifest.xml

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.webkit.PermissionRequest" />

<uses-feature android:name="android.hardware.camera" />
<uses-feature android:name="android.hardware.camera.autofocus" />
<uses-feature android:name="android.hardware.camera2.full" />
<uses-feature android:name="android.hardware.camera2.autofocus" />

We suggest the use of webviews based on Chromium with some customizations for better functioning of JavaScript. You can find an implementation example through POC.

IOS

COMPATIBILITY WITH OPERATING SYSTEM

The Web SDK supports webviews running on iOS 13 or higher.

DEVICE COMPATIBILITY

The tool is compatible with the vast majority of devices. The following table lists the devices tested in the laboratory. Some extensions listed may be subject to manufacturer-specific API levels or SKUs:

Device	S.O. version	Selfie Camera with Manual Capture	Smart Capture Selfie Camera	Document Camera with Manual Capture
Iphone 12 Pro Max	iOS 16.0
Iphone 12	iOS 16.0
Iphone 11	iOS 16.0
Iphone 8	iOS 15.5
Iphone 7	iOS 15.6.1
Iphone 7	iOS 14.3
Iphone 6s	iOS 13.5.1
Iphone 6s	iOS 13.1.3

WARNING

The partner FaceTec guarantees the functioning of the webview. With this, the webview can also be used in Selfie camera FaceTec proof-of-life mode.

DEPLOYMENT

For the SDK to work correctly, it is necessary to add some permissions and settings to the info.plist file, they are:

<key>NSCameraUsageDescription</key>
<string>Camera usage description</string>

iOS provides two ways to use Webviews in applications, they are: WKWebView and SFSafariViewController. We recommend using SFSafariViewController for better compatibility with DOM features. You can find an implementation example through POC.

COMMUNICATION FLOW WITH THE NATIVE APPLICATION

We provide a POC that exemplifies a communication flow of the return of a Web application with the SDK for a native iOS application using webview, this example can be found here.

Available features

The following features are available in the SDK:

• Face Capture;
  • Manual image capture;
  • Smart Camera image capture;
  • Image capture with liveness-proven (Smartlive with interaction FaceTec);
• Document Capture;

Fallback to Smart Camera mode

Older phones may not support some feature required by the computer vision technologies used in Smart Camera feature. In these cases, the Manual Camera mode will be triggered as a fallback, allowing the user to manually capture his face image.

This kind of fallback is not available for Smartlive with interaction FaceTec mode.

How it works

The client-side SDK is responsible for simplifying your integration with Unico Check, abstracting all the complexity related to camera manipulation and image capture.

After a successful capture, the SDK returns an object that must be sent to the REST APIs to complete the biometric validation.

1. Users accesses your application;
2. Through the SDK, your application requests the image capture frame (as configured in your application);
3. Your application renders the image capture frame of the Unico Check in a pre-configured placeholder;
4. Your application captures the image (automatically, manually or in Liveness-proven mode), generating a JWT token;

Alert

The Encrypted attribute is strictly intended for sending the image through the Unico APIs. You should not open and serialize this attribute, as its characteristics may change without notice. Its use must be exclusive in interactions with the APIs to guarantee the data integrity and security. Unico is not responsible for any damages arising from this practice, since the changes may occur unpredictably.

5. Your application sends the JWT to your server;
6. Your server call the REST APIs of Unico Check to validate the images (Documentation of the APIs can be found at this link)
7. The server returns the biometric validation response, to be forwarded to your application;

Getting help

Are you missing something or still need help? Please, please get in touch with the support team at help center.

Next steps

• Learn how to capture selfies with the SDK.
• Learn how to capture image of documents with the SDK.
• Learn more about the SDK in the Reference documentation.
• Check the REST APIs documentation.