@regulaforensics/facesdk-webclient 8.4.819-nightly → 8.4.821-nightly

package/dist/index.d.ts

@@ -384,6 +384,31 @@ export declare interface DeviceInfo {
     'version': string | null;
 }
 
+/**
+ * Result of the enrollment requested at session start via the `enroll` parameter. Returned only when enrollment was requested and the Enroll and Verify feature is enabled. Populated after the liveness check completes successfully.
+ */
+export declare interface EnrollResult {
+    /**
+     * Whether a new Person was created during enrollment. `true` when a new Person was created; `false` when a matching Person was found during the pre-enrollment search and no new Person was created.
+     */
+    'enrolled'?: boolean;
+    /**
+     * The Person created during enrollment. Present only when `enrolled` is `true`.
+     */
+    'person'?: Person;
+    'search'?: EnrollSearchResult;
+}
+
+/**
+ * Result of the 1:N search performed before enrollment when `enroll.search` is provided at session start. Present only when at least one matching Person is found. In this case, no new Person is created.
+ */
+export declare interface EnrollSearchResult {
+    /**
+     * Persons found during the pre-enrollment search.
+     */
+    'persons'?: Array<SearchPerson>;
+}
+
 /**
  * NOTE: This file is auto generated by OpenAPI Generator.
  * Do not edit the file manually.
@@ -1535,12 +1560,14 @@ export declare interface TransactionInfo {
      */
     'portrait'?: string;
     /**
-     * A free-form object containing person\'s extended attributes.
+     * A free-form object containing the Person\'s extended attributes.
      */
     'metadata'?: {
         [key: string]: any;
     };
     'type'?: LivenessType;
+    'enrollResult'?: EnrollResult;
+    'verifyResult'?: VerifyResult;
 }
 
 /**
@@ -1576,4 +1603,37 @@ export declare interface UpdateGroup {
     'removeItems'?: Array<string>;
 }
 
+/**
+ * Result of the verification requested at session start via the `verify` parameter. Returned only when verification was requested and the Enroll and Verify feature is enabled.
+ */
+export declare interface VerifyResult {
+    /**
+     * Whether the Person was successfully verified. `true` when the liveness check succeeds and the liveness portrait matches the enrolled Person according to the specified threshold; `false` when the liveness check fails or the faces do not match.
+     */
+    'verified'?: boolean;
+    /**
+     * The Person the liveness portrait was verified against.
+     */
+    'person'?: Person;
+    'match'?: VerifyResultMatch;
+}
+
+/**
+ * NOTE: This file is auto generated by OpenAPI Generator.
+ * Do not edit the file manually.
+ */
+/**
+ * Face comparison details. Present when the liveness check succeeds.
+ */
+export declare interface VerifyResultMatch {
+    /**
+     * Whether the faces matched according to the specified similarity threshold. `true` when the face similarity meets the threshold; `false` when it does not.
+     */
+    'verified'?: boolean;
+    /**
+     * Face similarity score in the range from `0` to `1`.
+     */
+    'similarity'?: number;
+}
+
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regulaforensics/facesdk-webclient",
-  "version": "8.4.819-nightly",
+  "version": "8.4.821-nightly",
   "description": "JS client for facesdk web service",
   "author": "Regula Forensics, Inc.",
   "keywords": [