Skip to content

Commit

Permalink
Merge pull request #25 from iProov/5.1.1
Browse files Browse the repository at this point in the history 
5.1.1 docs
  • Loading branch information
@GlenHughes
GlenHughes authored Apr 9, 2024
2 parents 61289d7 + d96f32a commit a50530b
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 41 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 08.04.2024 5.1.1

## Fixed

- **SIM**: Fixed issue with Express claims (previous Liveness) where if no face is detected immediately and SIM is enabled the SDK could crash.

## 20.02.2024 5.1.0

## Added
Expand Down
82 changes: 41 additions & 41 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![iProov: Biometric Face Verification for Remote Identity Assurance](https://github.com/iProov/web/raw/master/images/banner.png)

# iProov Biometrics Web SDK v5.1.0
# iProov Biometrics Web SDK v5.1.1

## 📖 Table of contents

Expand Down Expand Up @@ -238,7 +238,7 @@ You can customize the look and feel of the main layout by changing the following
Color option changes introduced in [v4.0.0](https://github.com/iProov/web/releases/tag/v4.0.0):

| Color Option | Description |
| ---------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------|
| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| **title_text_color** | Adjusts the color of the text that can be added above the oval (by default there is no text here - see the custom_title option for more information) |
| **surround_color** | Adjusts the color of the surroundings to the centre oval. It also affects the color of the mask in Liveness with `clear` or `blur` filter. |
| **prompt_text_color** | Adjusts the color of the text visible in the centre prompt of the screen |
Expand Down Expand Up @@ -449,22 +449,22 @@ To integrate with our localization feature, use special class names in your slot
The following is the complete list of slots can be used with the `<iproov-me>` web component and have associated [events](#-events):

| Slot | Description |
| ------------------------ | ---------------------------------------------------------------------------------------------------------- |
| **button** \* | Element that a user taps or clicks on to launch into fullscreen and start iProov |
| **camera_selector** \*\* | Label and dropdown populated with available cameras, if multiple cameras are detected. |
| **canceled** | State displayed to the user when they exit fullscreen before iProoving |
| **error** | State displayed to the user in the event of an error |
| **failed** | State displayed to the user when the user failed iProov |
| **grant_button** \* | Element that user taps or clicks to grant camera permission |
| **grant_permission** | State displayed to the user when camera or motion permission is unknown and not blocked |
| **no_camera** | State displayed to the user when there is no camera |
| **passed** | State displayed to the user when the user passed iProov |
| **permission_denied** | State displayed to the user when camera permission has been blocked |
| **progress** | State displayed to the user when streaming has completed and iProov is processing the result |
| **ready** | State displayed to the user when the component is ready to start the main iProov user journey |
| **rotate_portrait** \*\*\* | State displayed to the user when a handheld device is not in portrait orientation |
| **unsupported** | State displayed to the user when their browser is not supported |
| Slot | Description |
| -------------------------- | --------------------------------------------------------------------------------------------- |
| **button** \* | Element that a user taps or clicks on to launch into fullscreen and start iProov |
| **camera_selector** \*\* | Label and dropdown populated with available cameras, if multiple cameras are detected. |
| **canceled** | State displayed to the user when they exit fullscreen before iProoving |
| **error** | State displayed to the user in the event of an error |
| **failed** | State displayed to the user when the user failed iProov |
| **grant_button** \* | Element that user taps or clicks to grant camera permission |
| **grant_permission** | State displayed to the user when camera or motion permission is unknown and not blocked |
| **no_camera** | State displayed to the user when there is no camera |
| **passed** | State displayed to the user when the user passed iProov |
| **permission_denied** | State displayed to the user when camera permission has been blocked |
| **progress** | State displayed to the user when streaming has completed and iProov is processing the result |
| **ready** | State displayed to the user when the component is ready to start the main iProov user journey |
| **rotate_portrait** \*\*\* | State displayed to the user when a handheld device is not in portrait orientation |
| **unsupported** | State displayed to the user when their browser is not supported |

> \* Interactive elements such as buttons that start full screen and cameras require a user gesture enforced by the browser. Using JavaScript to apply clicks is not recommended within your user journey and may cause unexpected errors or performance degradation.
> See our [User Gestures Wiki](https://github.com/iProov/web/wiki/User-Gestures) for more details.
Expand Down Expand Up @@ -492,13 +492,13 @@ The available events are detailed below with any extra properties that are suppl

| Event | Extra Properties | Description |
| ----------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **canceled** | _feedback, reason_ | User has canceled iProov by exiting fullscreen |
| **canceled** | _feedback, reason_ | User has canceled iProov by exiting fullscreen |
| **connecting** | None | The SDK is connecting to the server. You should provide an indeterminate progress indicator to let the user know that the connection is taking place. |
| **connected** | None | The SDK has connected. You should hide any progress indication at this point. |
| **error** | _feedback, reason_ | iProov encountered an error while processing the authentication |
| **failed** | _type, passed, feedback, reason_ | Authentication was unsuccessful, the user needs to try again |
| **multiple_cameras** \* | _devices, device_selector, slot, label_ | If `enable_camera_selector` is `true` returns an array of devices if more than 1 video device is detected |
| **no_camera** | _feedback, reason_ | No video input was detected on the user's device |
| **no_camera** | _feedback, reason_ | No video input was detected on the user's device |
| **passed** | _type, feedback, reason, passed_ | Authentication was successful, the result can now be validated |
| **permission** | _reason_ | Camera permission is unknown & not blocked, show permission |
| **permission_denied** | _feedback, reason_ | User has blocked access to the camera |
Expand All @@ -513,20 +513,20 @@ The available events are detailed below with any extra properties that are suppl
Properties of the event's **detail** payload:

| Property | Events | Description |
| -------------------- | --------------------------------------- | ---------------------------------------------------------- |
| **token** | All | The token associated with the authentication attempt |
| **type** (†) | _passed, failed_ | The type of authentication (`enrol` or `verify`) |
| **passed** | _passed, failed_ | Boolean value whether the result passed or failed |
| **frame** (†) (\*) | _passed, failed_ | An `ImageData` from the scanning process |
| **progress** | _progress_ | A percentage (between 0 and 100) representing the progress |
| **message** | _progress_ | A user-friendly description of the current progress stage |
| Property | Events | Description |
| -------------------- | -------------------------------------- | ---------------------------------------------------------- |
| **token** | All | The token associated with the authentication attempt |
| **type** (†) | _passed, failed_ | The type of authentication (`enrol` or `verify`) |
| **passed** | _passed, failed_ | Boolean value whether the result passed or failed |
| **frame** (†) (\*) | _passed, failed_ | An `ImageData` from the scanning process |
| **progress** | _progress_ | A percentage (between 0 and 100) representing the progress |
| **message** | _progress_ | A user-friendly description of the current progress stage |
| **feedback** | _canceled, failed, error, unsupported_ | A fixed feedback code for making logical decisions |
| **reason** | _canceled, failed, error, unsupported_ | An English description of the reason for the event |
| **slot** | _multiple_cameras_ | The relevant slot for the event, for ease of use |
| **devices** | _multiple_cameras_ | Array of suitable `InputDevice`s for imagery capture |
| **device_selector** | _multiple_cameras_ | The multiple camera selection `<select>` element |
| **is_native_bridge** | All | Boolean value if event originates from the native bridge |
| **slot** | _multiple_cameras_ | The relevant slot for the event, for ease of use |
| **devices** | _multiple_cameras_ | Array of suitable `InputDevice`s for imagery capture |
| **device_selector** | _multiple_cameras_ | The multiple camera selection `<select>` element |
| **is_native_bridge** | All | Boolean value if event originates from the native bridge |

> - The `frame` property is for UI/UX purposes only and is only available if enabled on your service provider and token configuration. Imagery upon which authentication may later rely must be obtained from the token validate endpoint by a secure server-to-server call.
> - The **type** and **frame** properties are not available when running in Native Bridge mode.
Expand Down Expand Up @@ -563,15 +563,15 @@ In all events, corresponding _reason_ field can be displayed to the user.
> ⚠️ This declares support for the new codes in the SDK. It does NOT define when the new codes will be produced by our servers.
> This capability will be delivered in the future for Liveness Assurance.
| Feedback | Reason |
| ----------------- | ----------------------------------------------------- |
| **eyes_closed** | Keep your eyes open |
| **multiple_faces**| Ensure only one person is visible |
| **obscured_face** | Remove any face coverings |
| **sunglasses** | Remove sunglasses |
| **too_bright** | Ambient light too strong or screen brightness too low |
| **too_dark** | Your environment appears too dark |
| **unknown** | Try again |
| Feedback | Reason |
| ------------------ | ----------------------------------------------------- |
| **eyes_closed** | Keep your eyes open |
| **multiple_faces** | Ensure only one person is visible |
| **obscured_face** | Remove any face coverings |
| **sunglasses** | Remove sunglasses |
| **too_bright** | Ambient light too strong or screen brightness too low |
| **too_dark** | Your environment appears too dark |
| **unknown** | Try again |

### Error Feedback Codes

Expand Down

0 comments on commit a50530b

Please sign in to comment.