bry-biometric-collector 2.2.12 → 2.2.13-RC02

package/README.md

@@ -130,6 +130,12 @@ Currently supported tag parameters:
 
   Example: `extension_url_mozilla="https://www.bry.com.br/downloads/extension/v2/api/v1/extension-api.js"`
 
+- **evaluate_photo**: Wether to enable photo evaluation in the facial capture process. If enabled, the evaluation endpoint also has to be set.
+
+  Default: `true`
+
+  Example: `evaluate_photo=false`
+
 - **show_capture_button**: Wether to hide capture button. If you enable a button to trigger manual capture, it will be shown below the video.
 
   Default: `true`
@@ -142,12 +148,18 @@ Currently supported tag parameters:
 
   Example: `show_unconformities=false`
 
-- **video_filter**: Camera filter/color outside the oval area. Possible values are `"blur", "none", "white",
+- **video_overlay**: Camera filter/color outside the oval area. Possible values are `"none", "white",
 "blue", "red", "green", "gray", "yellow", "black"`. HTML colors are also accepted.
 
-  Default: `blur`
+  Default: `white`
+
+  Example: `video_overlay=white` 
+
+- **video_overlay_transparency**: Specifies the level of transparency for the filter/color applied outside the oval area of the camera. The value is given on a scale from 0 to 100, where 0 means fully opaque and 100 means fully transparent.
 
-  Example: `video_filter=white`
+  Default: `0`
+
+  Example: `video_overlay_transparency=60`
 
 - **show_config_button**: Wether to hide config button. It will be shown below the video on the left side.
 
@@ -178,7 +190,7 @@ Currently supported tag parameters:
 
 The Web-component exports a series of functions that the host environment may call. These functions are called by simply getting the html element from the page and invoking them. The following actions can be performed during run-time from the host environment:
 
-- **setBioAcJWTToken**\*: Required when using face collector (for now). Sets the JTWToken to perform face validations on the specified back-end. Receives a string _token_, a string for the base URL, and a string path to the evaluate biometrics endpoint. This endpoint was previously used for both fingers and face validations, now however, we only use it for face validation. The endpoint should accept a post containing in the body an object with a list of BodyParts, such as described [here](src/lib/remote/bioacService.ts). The return is expected to be an object containing a list called bodyParts conforming to the BodyPartReturnType interface, but also a field called icaoWarnings containing an array of unconformities in string form.
+- **setBioAcJWTToken**\*: Sets the JTWToken to perform face validations on the specified back-end. This configuration is necessary when the `evaluate_photo` parameter has a value of `true`. Receives a string _token_, a string for the base URL, and a string path to the evaluate biometrics endpoint. This endpoint was previously used for both fingers and face validations, now however, we only use it for face validation. The endpoint should accept a post containing in the body an object with a list of BodyParts, such as described [here](src/lib/remote/bioacService.ts). The return is expected to be an object containing a list called bodyParts conforming to the BodyPartReturnType interface, but also a field called icaoWarnings containing an array of unconformities in string form.
 
   Example:
 
@@ -503,6 +515,13 @@ The web component listens to and emits a few events. The events emitted are:
 
 - **face-scrapped**: When the user scraps their face (by clicking capture again after having saved their picture) this event gets emitted without any data.
 
+- **face-unconformities-validated**: When the photo is captured and after evaluating it, an event of this kind is emitted with their picture like so:
+
+```ts
+  {detail: {bodyParts[{bodyPart:'FACE', data: string, livenessBlob: string *, livenessResult: string}]}
+  * only if liveness_enable=true
+```
+
 - **export-face**: When the user saves their face (by clicking finish), an event of this kind is emitted with their picture like so:
 
 ```ts