bry-biometric-collector 2.2.18-RC01 → 2.2.18-RC02

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -191,6 +191,12 @@ Currently supported tag parameters:
191
191
 
192
192
  Example: `show_justification_field=false`
193
193
 
194
+ - **min_eye_to_eye_dist**: The minimum distance between the eyes that should be accepted on face collector.
195
+
196
+ Default: `0`
197
+
198
+ Example: `min_eye_to_eye_dist=50`
199
+
194
200
  ### **Run-time Configuration**
195
201
 
196
202
  #### **Functions**
@@ -526,10 +532,16 @@ The web component listens to and emits a few events. The events emitted are:
526
532
 
527
533
  ```ts
528
534
  {detail: {bodyParts[{bodyPart:'FACE', data: string, livenessBlob: string *, livenessResult: string},
529
- {bodyPart:'FACE_CROPPED', data: string}]} *
535
+ {bodyPart:'FACE', resized: true, data: string}]} *
530
536
  * only if liveness_enable=true
531
537
  ```
532
538
 
539
+ - **low-face-quality**: When the photo is captured and the distance between the eyes is below the minimum required (min_eye_to_eye_dist), this event is emitted.
540
+
541
+ ```ts
542
+ {detail: {bodyParts[{bodyPart: 'FACE', minEyeToEyeDist: number, capturedEyeToEyeDist: number}], errorCode: string, translatedError: string}}
543
+ ```
544
+
533
545
  - **export-face**: When the user saves their face (by clicking finish), an event of this kind is emitted with their picture like so:
534
546
 
535
547
  ```ts