Web components

Web component is an image capture tool that allows the user to perform registration and authorization through a web interface. To use the Web component, you need to register it on the server and configure it. All these actions are performed on the Web сomponents page in the dashboard.

Create a Web component

1. Click the Add Web component button at the top right of the page.

2. Enter the domain on which the Web component will be used, and, if necessary, a description. After adding the Web component, it will appear in the list.

Delete a Web component

To delete a Web component, click on the cross icon in the line. The Web component will be deleted after confirmation.

Web component settings

General settings

The following parameters of the Web component are configured:

• Enable or disable the Web component
• Enable or disable validation of data from a component on the server side. Enabling this setting disables server-side validation, allowing you to override component settings on the browser side. For example, deciding whether or not Motion Control video will be recorded based on browser data.
• The domain where the Web component is used
• Description of the Web component

The Web component ID field cannot be changed and is used to connect the Web component to the server.

Connection settings

You can select the type of connection between the web component and the server that will be used to record video:

• WebSocket (recommended)
• WebRTC
• HTTP

note

When using a component version lower than 1.8.0, the WebSocket connection type will activate HTTP-mode.

The following parameters are available for the WebRTC type:

• Enable or disable the display of WebRTC connection metrics such as FPS and network speed
• ICE candidates

To use a Web component with WebRTC, you always need to create an ICE candidate after creating the Web component. An ICE candidate describes the protocols and routing required for WebRTC to communicate with a remote device. To create an ICE candidate, click the Add ICE candidate button.

ICE candidate has the following configuration fields:

• The ICE candidate type (TURN or STUN)
• Protocol for client-server comunication (UPD or TCP)
• Candidate IP address
• Candidate port

Face model settings

The following parameters of the Web component are configured:

• Enable or disable a neural network for face detection
• Time in milliseconds after which Liveness Reflection recording will start if the neural network is disabled. This setting is active if a neural network for face detection is disabled.
• Path specifying where the neural models will be loaded from. The default value is /networks/

Video recorder settings

The following web component options are available in the video recorder settings:

• Enable or disable the calculation of the reference frame. The reference frame is needed to check the similarity between the face from the video and the best shot from the component. The comparison allows to exclude tampering of video checks with another face.

The access token to the video-recorder service and its encryption key are also displayed here.

Motion control settings

The following parameters of the Web component are configured:

• Enable or disable a Motion Control. If the neural network is disabled, then Motion Control will also be disabled.
• The position of the enabled module in the validation queue (Liveness Reflection, Motion Control). Note that if the positions of different modules are the same, the queue will be as follows: Liveness Reflection, Motion Control (This settings will be ignored in WebRTC connection mode).
• Number of attempts a user can take to complete Motion Control.
• Circle size for positioning the face in the frame and allowable deviations.
• GIF-hints for Motion Control commands that will be displayed during Motion Control testing.

Liveness reflection settings

The following parameters of the Web component are configured:

• Enable or disable Liveness Reflection. (This settings will be ignored in WebRTC connection mode)
• The position of the enabled module in the validation queue (Liveness Reflection, Motion Control). Note that if the positions of different modules are the same, the queue will be as follows: Liveness Reflection, Motion Control (This settings will be ignored in WebRTC connection mode).
• Number of attempts a user can take to complete Liveness Reflection.
• Circle size for positioning the face in the frame and allowable deviations.
• Settings for additional verification of user immobility during the Liveness Reflection test to increase the chance of a successful result. (This setting requires the face model to be enabled).

Fingerprint settings

The following parameters of the Web component are configured:

• Waiting time for collecting data about the environment in which the attempt is being made. Data that has not been received during this time will not be included in the final set.

Form settings

The following parameters of the Web component are configured:

• Enable or disable automatic sending of a validation request after all checks have passed.

Applicant fields settings

Here you can configure the fields that should be displayed during registration or authorization. The values of these fields will be sent to the request to create an applicant. The primary field determines by which key the applicant will be searched in the database.

Note that there must be only one primary field and it must be enabled, or all fields can be disabled if an applicantId has been passed to the Web component.

Camera settings

The following parameters of the Web component are configured:

• Enable or disable camera selection in Web component
• Selecting the preferred camera resolution. This setting does not indicate the exact resolution of the video stream, but only indicates the resolution that the browser will aim for.