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
- Click the Add Web component button at the top right of the page.
- 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
- 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.
WebRTC settings
The following parameters of the Web component are configured:
- Enable or disable WebRTC
- Enable or disable the display of WebRTC connection metrics such as FPS and network speed
- ICE candidates
If you want 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.
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.
- Number of attempts a user can take to complete Motion Control
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.
Resources settings
The following parameters of the Web component are configured:
- The path indicating where neural network for face detection will be loaded from
Form settings
The following parameters of the Web component are configured:
- Enable or disable automatic sending of a validation request after passing liveness
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.
Face settings
The following parameters of the Web component are configured:
- Width of the displayed face frame circumference for Full HD / HD / Mobile resolutions relative to the original width.
- Height of the displayed face frame circumference for Full HD / HD / Mobile resolutions relative to the original height.
- How much larger the displayed face frame circumference will be compared to the standard for the "closer" template.
- How much smaller the displayed face frame circumference will be compared to the standard for the "farther" template.
- The allowable difference in size between the displayed face frame and the face mask obtained using a neural network (measured in pixels).
