@regulaforensics/vp-frontend-face-components 6.2.1328-nightly → 6.2.1330-nightly
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 +21 -20
- package/dist/main.js +1 -1
- package/lib/index.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -186,26 +186,26 @@ component.settings = yourSettings;
|
|
|
186
186
|
Here are all the available settings:
|
|
187
187
|
|
|
188
188
|
|
|
189
|
-
| Setting
|
|
190
|
-
|
|
191
|
-
| `locale`
|
|
192
|
-
| `url`
|
|
193
|
-
| `copyright`
|
|
194
|
-
| `cameraId`
|
|
195
|
-
| `changeCamera`
|
|
196
|
-
| `startScreen`
|
|
197
|
-
| `finishScreen`
|
|
198
|
-
| `closeDisabled`
|
|
199
|
-
| `recordingProcess`
|
|
200
|
-
| `tag`
|
|
201
|
-
| `retryCount`
|
|
202
|
-
| `headers`
|
|
203
|
-
| `customization`
|
|
204
|
-
| `nonce`
|
|
205
|
-
| `rotationAngle`
|
|
206
|
-
| `holdStillDuration` | For the Capture screen, sets the duration that the user needs to stand straight and look in the camera.
|
|
207
|
-
| `timeoutInterval` | Timeout for the Capture screen.
|
|
208
|
-
|
|
189
|
+
| Setting | Info | Data type | Default value | Values | Used in |
|
|
190
|
+
|:--------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------:|:--------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|---------------------------------|
|
|
191
|
+
| `locale` | Language of the component. | `string` | `en` | `ru`, `en`, `de`, `pl`, `it`, `hu`, `zh`, `sk`, `uk`, `fr`, `es`, `pt`, `ar`, `nl`, `id`, `vi`, `ko`, `ms`, `ro`, `el`, `tr`, `ja`, `cs`, `th`, `hi`, `bn`, `he`, `fi`, `sv`, `da`, `hr`, `no` | `face-liveness`, `face-capture` |
|
|
192
|
+
| `url` | Backend URL. | `string` | `https://faceapi.regulaforensics.com/` | any url | `face-liveness` |
|
|
193
|
+
| `copyright` | Whether to show the Regula copyright footer. | `boolean` | `false` | `true`, `false` | `face-liveness`, `face-capture` |
|
|
194
|
+
| `cameraId` | Ability to select a camera by defining the camera ID. | `string` | `undefined` | `camera id string value` | `face-liveness`, `face-capture` |
|
|
195
|
+
| `changeCamera` | Whether to show the "Camera Switch" button. | `boolean` | `true` | `true`, `false` | `face-liveness`, `face-capture` |
|
|
196
|
+
| `startScreen` | Whether to show the Start screen with video instructions. If `true`, the start screen is shown. If `false`, no start screen is shown and instead the camera of the device is turned on automatically to capture a face. | `boolean` | `true` | `true`, `false` | `face-liveness`, `face-capture` |
|
|
197
|
+
| `finishScreen` | Whether to show the Result screen (`success screen`, `retry-screen`). If `true`, the Result screen is shown to the user. If `false`, no Result screen is displayed, and, during a single session, **the user has only one attempt to pass liveness assessment**. <br><br>In cases where `finishScreen` is set to `false`, we recommend to monitor [Events](#events) associated with the liveness assessment and then display relevant information to the user based on those events. This approach ensures that the user receives necessary feedback even though the Result screen is not displayed by the component itself. | `boolean` | `true` | `true`, `false` | `face-liveness`, `face-capture` |
|
|
198
|
+
| `closeDisabled` | Whether to disable the "Close" button of the component. If set to `true`, the "Close" button is hidden from the user. | `boolean` | `false` | `true`, `false` | `face-liveness`, `face-capture` |
|
|
199
|
+
| `recordingProcess` | Whether to enable a video recording of the process. If set to `0`, the video is sent to the server with an additional request. If set to `1`, the video is sent to the server with the liveness package. If set to `2`, the video isn't sent. The video format depends on the browser: MP4 for Safari, WEB for other browsers. | `number` | `0` | `0`, `1`, `2` | `face-liveness` |
|
|
200
|
+
| `tag` | The server generates a unique identifier for each session before starting a verification process. Using `tag`, you can set a custom value. Make sure that `tag` is unique for each session. | `string` | `undefined` | any unique for each session | `face-liveness` |
|
|
201
|
+
| `retryCount` | Using the `retryCount` setter, you can set the number of liveness transaction attempts for the user. Once the attempts are exhausted, the component will display a white screen and throw the "RETRY_COUNTER_EXCEEDED" event. By default, the number of attempts is unlimited. Setting the value to **0** removes the limit on the number of attempts, while any positive number limits the attempts. | `number` | `-1` | number of the attempts count | `face-liveness` |
|
|
202
|
+
| `headers` | Before starting the camera capture, the component sends a `start` request to the server and receives the initialization data in response. Once the component successfully completes two stages of verification, it sends the received data to the API for processing. You can use the `headers` setter to set the headers for the HTTP POST method. Additionally, the video recording is transmitted to the server along with these `headers`. | `object` | `undefined` | object with headers (key, value). | `face-liveness` |
|
|
203
|
+
| `customization` | You can customize the element's color, font, and image by using this object. See the [Customization](#customization) section below. | `object` | `undefined` | object with customization settings | `face-liveness`, `face-capture` |
|
|
204
|
+
| `nonce` | You can set a unique nonce value to maintain the CSP policy. | `string` | `undefined` | unique nonce value | `face-liveness`, `face-capture` |
|
|
205
|
+
| `rotationAngle` | Desktop only. By using the `rotationAngle` setter, you can specify an angle to compensate for the rotation of your physical camera. When set to values of `90` and `-90`, the component's design will switch to a mobile (vertical) orientation. | `number` | `undefined` | `0`,`180`,`90`,`-90` | `face-liveness`, `face-capture` |
|
|
206
|
+
| `holdStillDuration` | For the Capture screen, sets the duration that the user needs to stand straight and look in the camera. | `number` | `undefined` | seconds | `face-capture` |
|
|
207
|
+
| `timeoutInterval` | Timeout for the Capture screen. | `number` | `undefined` | seconds | `face-capture` |
|
|
208
|
+
| `livenessType` | You can choose a scenario for the liveness assessment. `0` - active liveness, full process that requires head rotation; `1` - passive liveness, a person is asked to only take a selfie, no head rotation required. | `number` | `0` | `0`, `1` | `face-liveness` |
|
|
209
209
|
|
|
210
210
|
## Customization
|
|
211
211
|
|
|
@@ -580,6 +580,7 @@ The `face-liveness` response has the following structure:
|
|
|
580
580
|
status: number // liveness status: 0 if the person's liveness is confirmed, 1 if not.
|
|
581
581
|
estimatedAge: number | null // approximate age with an accuracy of +/-3 years
|
|
582
582
|
transactionId: string
|
|
583
|
+
type: number // liveness type: 0 - active, 1 - passive
|
|
583
584
|
images: string[] // array with the final image in base64
|
|
584
585
|
}
|
|
585
586
|
````
|