@regulaforensics/vp-frontend-face-components 8.4.2390-nightly → 8.4.2392-nightly

package/README.md

@@ -221,8 +221,8 @@ Here are all the available settings:
 | `tenant`            | A label used to group transactions by specific customers, applications, or other criteria.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | `string`  |              `undefined`               |                                                                                                            tenant                                                                                                            | `face-liveness`, `face-enroll`, `face-verify`                 |
 | `env`               | A label used to differentiate transactions by development stages.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | `string`  |              `undefined`               |                                                                                                             env                                                                                                              | `face-liveness`, `face-enroll`, `face-verify`                 |
 | `captureButton`     | Whether to enable user-triggered capture. Shows the **Capture** button, desktop layout height increases accordingly. When enabled, the shot is taken only on user action. When `livenessType` is set to `3` (passive liveness with blink), `captureButton` is not supported.                                                                                                                                                                                                                                                                                                                                                 | `boolean` |                `false`                 |                                                                                                       `true`, `false`                                                                                                        | `face-liveness`, `face-capture`, `face-enroll`, `face-verify` |
-| `enroll`            | Person enrollment configuration. Required for `face-enroll`. Must contain the `person` object; `search` is optional. For details, see <a href="https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/enroll-verify/" target="_blank">Enroll and Verify</a>.                                                                                                                                                                                                                                                                                                                                        | `object`  |              `undefined`               |                                                                                          object with `person` and optional `search`                                                                                          | `face-enroll`                                                 |
-| `verify`            | Person verification configuration. Required for `face-verify`. Must contain either `personId` or `externalId`; `threshold` is optional. For details, see <a href="https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/enroll-verify/" target="_blank">Enroll and Verify</a>.                                                                                                                                                                                                                                                                                                                     | `object`  |              `undefined`               |                                                                                  `{ personId, threshold? }` or `{ externalId, threshold? }`                                                                                  | `face-verify`                                                 |
+| `enroll`            | Person enrollment configuration. Required for `face-enroll`. For details, see <a href="https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/enroll-verify/" target="_blank">Enroll and Verify</a>.                                                                                                                                                                                                                                                                                                                                                                                                | `object`  |              `undefined`               |                                                                                          object with `person` and optional `search`                                                                                          | `face-enroll`                                                 |
+| `verify`            | Person verification configuration. Required for `face-verify`. For details, see <a href="https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/enroll-verify/" target="_blank">Enroll and Verify</a>.                                                                                                                                                                                                                                                                                                                                                                                              | `object`  |              `undefined`               |                                                                                       object with `personId` and optional `threshold`                                                                                        | `face-verify`                                                 |
 
 ## Customization
 

package/dist/index.d.ts

@@ -391,10 +391,14 @@ declare type SearchResult = {
 };
 
 declare type VerifyConfig = {
+    /**
+     * The person ID.
+     */
     personId: string;
-    threshold?: number;
-} | {
-    externalId: string;
+    /**
+     * The similarity threshold.
+     * Default: 0.8
+     */
     threshold?: number;
 };