@facesignai/api 1.0.35 → 1.0.37

package/README.md

@@ -349,6 +349,57 @@ Sends a one-time password (OTP) to the user's email address and verifies the cod
 }
 ```
 
+### FACE_COMPARE Node
+
+Compares faces from two different sources to verify they belong to the same person. Unlike FACE_SCAN (which captures a photo and compares it against a single reference), this node takes already-existing images from different session sources and compares them.
+
+**Available sources:**
+- `sessionVideo` — a frame captured from the live video feed during the session
+- `faceScan` — a higher-quality photo from a FACE_SCAN node (oval capture). Uses the most recent completed FACE_SCAN node in the session.
+- `providedData` — an image URL from a `providedData` field. Requires `providedDataKey` to specify which field contains the URL.
+- `documentPhoto` — a photo extracted from a scanned document (DOCUMENT_SCAN node). Uses the most recent completed DOCUMENT_SCAN node in the session.
+
+**Configuration:**
+- `sourceA` — first image source
+- `sourceB` — second image source
+- `similarityThreshold` — optional minimum similarity score (0–1) required for a match
+
+**Outcomes:**
+- `match` — faces from both sources match
+- `noMatch` — faces do not match
+- `imageUnavailable` — at least one image could not be obtained (e.g., no person detected on camera, missing `providedData` field, no photo on document, etc.)
+
+**Example — compare live video with a photo from providedData:**
+```typescript
+{
+  id: "compare-faces",
+  type: "face_compare",
+  sourceA: { source: "sessionVideo" },
+  sourceB: { source: "providedData", providedDataKey: "photoUrl" },
+  similarityThreshold: 0.8,
+  outcomes: {
+    match: "next-node-id",
+    noMatch: "end-fail",
+    imageUnavailable: "end-error"
+  }
+}
+```
+
+**Example — compare face scan capture with document photo:**
+```typescript
+{
+  id: "compare-scan-vs-doc",
+  type: "face_compare",
+  sourceA: { source: "faceScan" },
+  sourceB: { source: "documentPhoto" },
+  outcomes: {
+    match: "next-node-id",
+    noMatch: "end-fail",
+    imageUnavailable: "end-error"
+  }
+}
+```
+
 ### TWO_FACTOR_SMS Node
 
 Same as TWO_FACTOR_EMAIL but sends the OTP via SMS. If no phone number was provided via `providedData` or collected by a previous node, the phone number will be requested automatically during this node.

package/build/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@facesignai/api",
     "package-name": "@facesignai/api",
-    "version": "1.0.35",
+    "version": "1.0.37",
     "description": "Facesign API wrapper",
     "repository": {
         "type": "git",

package/build/src/types/nodeReports.d.ts

@@ -1,4 +1,4 @@
-import { FSNodeType, FSNodeId, FSLivenessDetectionOutcome, FSEnterEmailOutcome, FSDocumentScanOutcome, FSRecognitionOutcome, FSFaceScanOutcome, FSTwoFactorOutcome, FSPermissionsOutcome } from "./nodes";
+import { FSNodeType, FSNodeId, FSLivenessDetectionOutcome, FSEnterEmailOutcome, FSDocumentScanOutcome, FSRecognitionOutcome, FSFaceScanOutcome, FSTwoFactorOutcome, FSPermissionsOutcome, FSFaceCompareOutcome } from "./nodes";
 import { DocumentScanReport } from "./docScanning";
 export type NodeReportBase = {
     type: FSNodeType;
@@ -80,5 +80,17 @@ export type PermissionsNodeReport = NodeReportBase & {
     type: FSNodeType.PERMISSIONS;
     outcome: FSPermissionsOutcome;
 };
-export type NodeReport = ConversationNodeReport | LivenessDetectionNodeReport | EnterEmailNodeReport | DataValidationNodeReport | DocumentScanNodeReport | RecognitionNodeReport | TwoFactorEmailNodeReport | TwoFactorSMSNodeReport | FaceScanNodeReport | PermissionsNodeReport;
+export type FaceCompareReport = {
+    isMatch: boolean;
+    similarity?: number;
+    sourceAImageFound: boolean;
+    sourceBImageFound: boolean;
+    error?: string;
+};
+export type FaceCompareNodeReport = NodeReportBase & {
+    type: FSNodeType.FACE_COMPARE;
+    outcome: FSFaceCompareOutcome;
+    report?: FaceCompareReport;
+};
+export type NodeReport = ConversationNodeReport | LivenessDetectionNodeReport | EnterEmailNodeReport | DataValidationNodeReport | DocumentScanNodeReport | RecognitionNodeReport | TwoFactorEmailNodeReport | TwoFactorSMSNodeReport | FaceScanNodeReport | PermissionsNodeReport | FaceCompareNodeReport;
 //# sourceMappingURL=nodeReports.d.ts.map

package/build/src/types/nodeReports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nodeReports.d.ts","sourceRoot":"","sources":["../../../src/types/nodeReports.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,QAAQ,EACR,0BAA0B,EAC1B,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,SAAS,CAAA;AAEhB,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAElD,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,eAAe,GACvB;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,KAAK,CAAA;CAAE,GACtC;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GACtC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1C,MAAM,MAAM,wBAAwB,GAAG,cAAc,GAAG;IACtD,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAA;IACjC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,cAAc,CAAA;IAC/B,OAAO,EAAE,kBAAkB,CAAA;IAC3B,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,oBAAoB,EAAE,OAAO,CAAA;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IAChD,IAAI,EAAE,UAAU,CAAC,SAAS,CAAA;IAC1B,OAAO,EAAE,iBAAiB,CAAA;IAC1B,MAAM,CAAC,EAAE,cAAc,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG;IACvD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG;IACnD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,OAAO,EAAE,oBAAoB,CAAA;IAC7B,MAAM,CAAC,EAAE,iBAAiB,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,aAAa,CAAA;IAC9B,OAAO,EAAE,qBAAqB,CAAA;IAC9B,MAAM,CAAC,EAAE,kBAAkB,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,cAAc,GAAG;IACtD,IAAI,EAAE,UAAU,CAAC,eAAe,CAAA;IAChC,OAAO,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,OAAO,EAAE,mBAAmB,CAAA;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,cAAc,GAAG;IACzD,IAAI,EAAE,UAAU,CAAC,kBAAkB,CAAA;IACnC,OAAO,EAAE,0BAA0B,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,YAAY,CAAA;IAC7B,OAAO,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG;IACnD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,OAAO,EAAE,oBAAoB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,UAAU,GAClB,sBAAsB,GACtB,2BAA2B,GAC3B,oBAAoB,GACpB,wBAAwB,GACxB,sBAAsB,GACtB,qBAAqB,GACrB,wBAAwB,GACxB,sBAAsB,GACtB,kBAAkB,GAClB,qBAAqB,CAAA"}
+{"version":3,"file":"nodeReports.d.ts","sourceRoot":"","sources":["../../../src/types/nodeReports.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,QAAQ,EACR,0BAA0B,EAC1B,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,SAAS,CAAA;AAEhB,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAElD,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,eAAe,GACvB;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,KAAK,CAAA;CAAE,GACtC;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GACtC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1C,MAAM,MAAM,wBAAwB,GAAG,cAAc,GAAG;IACtD,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAA;IACjC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,cAAc,CAAA;IAC/B,OAAO,EAAE,kBAAkB,CAAA;IAC3B,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,oBAAoB,EAAE,OAAO,CAAA;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IAChD,IAAI,EAAE,UAAU,CAAC,SAAS,CAAA;IAC1B,OAAO,EAAE,iBAAiB,CAAA;IAC1B,MAAM,CAAC,EAAE,cAAc,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG;IACvD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG;IACnD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,OAAO,EAAE,oBAAoB,CAAA;IAC7B,MAAM,CAAC,EAAE,iBAAiB,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,aAAa,CAAA;IAC9B,OAAO,EAAE,qBAAqB,CAAA;IAC9B,MAAM,CAAC,EAAE,kBAAkB,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,cAAc,GAAG;IACtD,IAAI,EAAE,UAAU,CAAC,eAAe,CAAA;IAChC,OAAO,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,OAAO,EAAE,mBAAmB,CAAA;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,cAAc,GAAG;IACzD,IAAI,EAAE,UAAU,CAAC,kBAAkB,CAAA;IACnC,OAAO,EAAE,0BAA0B,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,YAAY,CAAA;IAC7B,OAAO,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG;IACnD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,OAAO,EAAE,oBAAoB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iBAAiB,EAAE,OAAO,CAAA;IAC1B,iBAAiB,EAAE,OAAO,CAAA;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG;IACnD,IAAI,EAAE,UAAU,CAAC,YAAY,CAAA;IAC7B,OAAO,EAAE,oBAAoB,CAAA;IAC7B,MAAM,CAAC,EAAE,iBAAiB,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,UAAU,GAClB,sBAAsB,GACtB,2BAA2B,GAC3B,oBAAoB,GACpB,wBAAwB,GACxB,sBAAsB,GACtB,qBAAqB,GACrB,wBAAwB,GACxB,sBAAsB,GACtB,kBAAkB,GAClB,qBAAqB,GACrB,qBAAqB,CAAA"}

package/build/src/types/nodes.d.ts

@@ -12,7 +12,8 @@ export declare enum FSNodeType {
     FACE_SCAN = "face_scan",
     TWO_FACTOR_EMAIL = "two_factor_email",
     TWO_FACTOR_SMS = "two_factor_sms",
-    PERMISSIONS = "permissions"
+    PERMISSIONS = "permissions",
+    FACE_COMPARE = "face_compare"
 }
 export interface FSNodeBase {
     id: string;
@@ -221,5 +222,45 @@ export declare enum FSPermissionsOutcome {
     PERMISSIONS_GRANTED = "permissionsGranted",
     PERMISSIONS_DENIED = "permissionsDenied"
 }
-export type FSNode = FSStartNode | FSConversationNode | FSEndNode | FSEnterEmailNode | FSLivenessDetectionNode | FSDataValidationNode | FSDocumentScanNode | FSRecognitionNode | FSFaceScanNode | FSTwoFactorNodeEmail | FSTwoFactorNodeSMS;
+export declare enum FSFaceCompareSource {
+    SESSION_VIDEO = "sessionVideo",
+    FACE_SCAN = "faceScan",
+    PROVIDED_DATA = "providedData",
+    DOCUMENT_PHOTO = "documentPhoto"
+}
+export type FSFaceCompareSourceConfig = {
+    source: FSFaceCompareSource.SESSION_VIDEO;
+} | {
+    source: FSFaceCompareSource.FACE_SCAN;
+} | {
+    source: FSFaceCompareSource.PROVIDED_DATA;
+    providedDataKey: string;
+} | {
+    source: FSFaceCompareSource.DOCUMENT_PHOTO;
+};
+export declare enum FSFaceCompareOutcome {
+    MATCH = "match",
+    NO_MATCH = "noMatch",
+    IMAGE_UNAVAILABLE = "imageUnavailable"
+}
+/**
+ * Compares faces from two different sources to verify they belong to the same person.
+ *
+ * Available sources:
+ * - `sessionVideo` — frame captured from the live video feed during the session
+ * - `faceScan` — higher-quality photo from a FACE_SCAN node (oval capture)
+ * - `providedData` — image URL from a `providedData` field (specify the key via `providedDataKey`)
+ * - `documentPhoto` — photo extracted from a scanned document (DOCUMENT_SCAN node)
+ *
+ * For `faceScan` and `documentPhoto`, the photo is taken from the most recent
+ * completed node of that type in the session.
+ */
+export interface FSFaceCompareNode extends FSNodeBase {
+    type: FSNodeType.FACE_COMPARE;
+    sourceA: FSFaceCompareSourceConfig;
+    sourceB: FSFaceCompareSourceConfig;
+    outcomes: Record<FSFaceCompareOutcome, FSNodeId>;
+    similarityThreshold?: number;
+}
+export type FSNode = FSStartNode | FSConversationNode | FSEndNode | FSEnterEmailNode | FSLivenessDetectionNode | FSDataValidationNode | FSDocumentScanNode | FSRecognitionNode | FSFaceScanNode | FSTwoFactorNodeEmail | FSTwoFactorNodeSMS | FSPermissionsNode | FSFaceCompareNode;
 //# sourceMappingURL=nodes.d.ts.map

package/build/src/types/nodes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nodes.d.ts","sourceRoot":"","sources":["../../../src/types/nodes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE1D,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAE/C,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,YAAY,iBAAiB;IAC7B,kBAAkB,uBAAuB;IACzC,WAAW,gBAAgB;IAC3B,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,gBAAgB,qBAAqB;IACrC,cAAc,mBAAmB;IACjC,WAAW,gBAAgB;CAC5B;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAC7B;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,IAAI,EAAE,UAAU,CAAC,KAAK,CAAA;IACtB,OAAO,EAAE,QAAQ,CAAA;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,IAAI,EAAE,UAAU,CAAC,YAAY,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;IAC7C,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED,oBAAY,0BAA0B;IACpC,iBAAiB,qBAAqB;IACtC,iBAAiB,qBAAqB;IACtC,OAAO,WAAW;CACnB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAwB,SAAQ,UAAU;IACzD,IAAI,EAAE,UAAU,CAAC,kBAAkB,CAAA;IACnC,QAAQ,EAAE,MAAM,CAAC,0BAA0B,EAAE,QAAQ,CAAC,CAAA;CACvD;AAED,oBAAY,mBAAmB;IAC7B,aAAa,iBAAiB;IAC9B,QAAQ,aAAa;CACtB;AACD;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAA;CAChD;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,IAAI,EAAE,UAAU,CAAC,eAAe,CAAA;IAChC,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;IAC7C,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,MAAM,CAAA;QACd,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;CACF;AAED,oBAAY,oBAAoB;IAC9B,UAAU,eAAe;IACzB,QAAQ,YAAY;IACpB,OAAO,WAAW;CACnB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAA;CACjD;AAED,MAAM,MAAM,cAAc,GAAG,YAAY,CAAA;AAEzC,oBAAY,qBAAqB;IAC/B,YAAY,gBAAgB;IAE5B,cAAc,kBAAkB;IAChC,OAAO,gBAAgB;CAGxB;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,CAAA;AAE7C;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,IAAI,EAAE,UAAU,CAAC,aAAa,CAAA;IAC9B,YAAY,EAAE,kBAAkB,CAAA;IAChC,oBAAoB,EAAE,cAAc,EAAE,CAAA;IAEtC,QAAQ,EAAE,MAAM,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAA;IACjD,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,sBAAsB,CAAC,EAAE,OAAO,CAAA;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,UAAU;IAC3C,IAAI,EAAE,UAAU,CAAC,GAAG,CAAA;CACrB;AAED,oBAAY,iBAAiB;IAC3B,MAAM,WAAW;IACjB,UAAU,cAAc;IACxB,SAAS,cAAc;IACvB,KAAK,UAAU;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,EAAE,UAAU,CAAC,SAAS,CAAA;IAC1B,QAAQ,EAAE,MAAM,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAA;IAG7C,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAG5B,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,oBAAY,kBAAkB;IAC5B,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ;AAED,oBAAY,kBAAkB;IAC5B,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,iBAAiB,sBAAsB;IACvC,SAAS,cAAc;IACvB,KAAK,UAAU;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,QAAQ,EAAE,MAAM,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAA;IAG9C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAG3B,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAA;IACjC,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD,IAAI,EAAE,UAAU,CAAC,cAAc,CAAA;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,WAAW,EAAE;QACX,MAAM,CAAC,EAAE,OAAO,CAAA;QAChB,UAAU,CAAC,EAAE,OAAO,CAAA;KACrB,CAAA;IACD,QAAQ,EAAE,MAAM,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAA;CACjD;AAED,oBAAY,oBAAoB;IAC9B,mBAAmB,uBAAuB;IAC1C,kBAAkB,sBAAsB;CACzC;AAED,MAAM,MAAM,MAAM,GACd,WAAW,GACX,kBAAkB,GAClB,SAAS,GACT,gBAAgB,GAChB,uBAAuB,GACvB,oBAAoB,GACpB,kBAAkB,GAClB,iBAAiB,GACjB,cAAc,GACd,oBAAoB,GACpB,kBAAkB,CAAA"}
+{"version":3,"file":"nodes.d.ts","sourceRoot":"","sources":["../../../src/types/nodes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE1D,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAE/C,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,YAAY,iBAAiB;IAC7B,kBAAkB,uBAAuB;IACzC,WAAW,gBAAgB;IAC3B,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,gBAAgB,qBAAqB;IACrC,cAAc,mBAAmB;IACjC,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;CAC9B;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAC7B;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,IAAI,EAAE,UAAU,CAAC,KAAK,CAAA;IACtB,OAAO,EAAE,QAAQ,CAAA;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,IAAI,EAAE,UAAU,CAAC,YAAY,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;IAC7C,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED,oBAAY,0BAA0B;IACpC,iBAAiB,qBAAqB;IACtC,iBAAiB,qBAAqB;IACtC,OAAO,WAAW;CACnB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAwB,SAAQ,UAAU;IACzD,IAAI,EAAE,UAAU,CAAC,kBAAkB,CAAA;IACnC,QAAQ,EAAE,MAAM,CAAC,0BAA0B,EAAE,QAAQ,CAAC,CAAA;CACvD;AAED,oBAAY,mBAAmB;IAC7B,aAAa,iBAAiB;IAC9B,QAAQ,aAAa;CACtB;AACD;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAA;CAChD;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,IAAI,EAAE,UAAU,CAAC,eAAe,CAAA;IAChC,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;IAC7C,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,MAAM,CAAA;QACd,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;CACF;AAED,oBAAY,oBAAoB;IAC9B,UAAU,eAAe;IACzB,QAAQ,YAAY;IACpB,OAAO,WAAW;CACnB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAA;CACjD;AAED,MAAM,MAAM,cAAc,GAAG,YAAY,CAAA;AAEzC,oBAAY,qBAAqB;IAC/B,YAAY,gBAAgB;IAE5B,cAAc,kBAAkB;IAChC,OAAO,gBAAgB;CAGxB;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,CAAA;AAE7C;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,IAAI,EAAE,UAAU,CAAC,aAAa,CAAA;IAC9B,YAAY,EAAE,kBAAkB,CAAA;IAChC,oBAAoB,EAAE,cAAc,EAAE,CAAA;IAEtC,QAAQ,EAAE,MAAM,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAA;IACjD,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,sBAAsB,CAAC,EAAE,OAAO,CAAA;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,UAAU;IAC3C,IAAI,EAAE,UAAU,CAAC,GAAG,CAAA;CACrB;AAED,oBAAY,iBAAiB;IAC3B,MAAM,WAAW;IACjB,UAAU,cAAc;IACxB,SAAS,cAAc;IACvB,KAAK,UAAU;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,EAAE,UAAU,CAAC,SAAS,CAAA;IAC1B,QAAQ,EAAE,MAAM,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAA;IAG7C,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAG5B,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,oBAAY,kBAAkB;IAC5B,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ;AAED,oBAAY,kBAAkB;IAC5B,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,iBAAiB,sBAAsB;IACvC,SAAS,cAAc;IACvB,KAAK,UAAU;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,QAAQ,EAAE,MAAM,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAA;IAG9C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAG3B,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAA;IACjC,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD,IAAI,EAAE,UAAU,CAAC,cAAc,CAAA;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,WAAW,EAAE;QACX,MAAM,CAAC,EAAE,OAAO,CAAA;QAChB,UAAU,CAAC,EAAE,OAAO,CAAA;KACrB,CAAA;IACD,QAAQ,EAAE,MAAM,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAA;CACjD;AAED,oBAAY,oBAAoB;IAC9B,mBAAmB,uBAAuB;IAC1C,kBAAkB,sBAAsB;CACzC;AAED,oBAAY,mBAAmB;IAC7B,aAAa,iBAAiB;IAC9B,SAAS,aAAa;IACtB,aAAa,iBAAiB;IAC9B,cAAc,kBAAkB;CACjC;AAED,MAAM,MAAM,yBAAyB,GACjC;IAAE,MAAM,EAAE,mBAAmB,CAAC,aAAa,CAAA;CAAE,GAC7C;IAAE,MAAM,EAAE,mBAAmB,CAAC,SAAS,CAAA;CAAE,GACzC;IAAE,MAAM,EAAE,mBAAmB,CAAC,aAAa,CAAC;IAAC,eAAe,EAAE,MAAM,CAAA;CAAE,GACtE;IAAE,MAAM,EAAE,mBAAmB,CAAC,cAAc,CAAA;CAAE,CAAA;AAElD,oBAAY,oBAAoB;IAC9B,KAAK,UAAU;IACf,QAAQ,YAAY;IACpB,iBAAiB,qBAAqB;CACvC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,UAAU,CAAC,YAAY,CAAA;IAC7B,OAAO,EAAE,yBAAyB,CAAA;IAClC,OAAO,EAAE,yBAAyB,CAAA;IAClC,QAAQ,EAAE,MAAM,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAA;IAChD,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED,MAAM,MAAM,MAAM,GACd,WAAW,GACX,kBAAkB,GAClB,SAAS,GACT,gBAAgB,GAChB,uBAAuB,GACvB,oBAAoB,GACpB,kBAAkB,GAClB,iBAAiB,GACjB,cAAc,GACd,oBAAoB,GACpB,kBAAkB,GAClB,iBAAiB,GACjB,iBAAiB,CAAA"}

package/build/src/types/nodes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FSPermissionsOutcome = exports.FSTwoFactorOutcome = exports.FSTwoFactorChannel = exports.FSFaceScanOutcome = exports.FSDocumentScanOutcome = exports.FSRecognitionOutcome = exports.FSEnterEmailOutcome = exports.FSLivenessDetectionOutcome = exports.FSNodeType = void 0;
+exports.FSFaceCompareOutcome = exports.FSFaceCompareSource = exports.FSPermissionsOutcome = exports.FSTwoFactorOutcome = exports.FSTwoFactorChannel = exports.FSFaceScanOutcome = exports.FSDocumentScanOutcome = exports.FSRecognitionOutcome = exports.FSEnterEmailOutcome = exports.FSLivenessDetectionOutcome = exports.FSNodeType = void 0;
 var FSNodeType;
 (function (FSNodeType) {
     FSNodeType["START"] = "start";
@@ -15,6 +15,7 @@ var FSNodeType;
     FSNodeType["TWO_FACTOR_EMAIL"] = "two_factor_email";
     FSNodeType["TWO_FACTOR_SMS"] = "two_factor_sms";
     FSNodeType["PERMISSIONS"] = "permissions";
+    FSNodeType["FACE_COMPARE"] = "face_compare";
 })(FSNodeType = exports.FSNodeType || (exports.FSNodeType = {}));
 var FSLivenessDetectionOutcome;
 (function (FSLivenessDetectionOutcome) {
@@ -67,3 +68,16 @@ var FSPermissionsOutcome;
     FSPermissionsOutcome["PERMISSIONS_GRANTED"] = "permissionsGranted";
     FSPermissionsOutcome["PERMISSIONS_DENIED"] = "permissionsDenied";
 })(FSPermissionsOutcome = exports.FSPermissionsOutcome || (exports.FSPermissionsOutcome = {}));
+var FSFaceCompareSource;
+(function (FSFaceCompareSource) {
+    FSFaceCompareSource["SESSION_VIDEO"] = "sessionVideo";
+    FSFaceCompareSource["FACE_SCAN"] = "faceScan";
+    FSFaceCompareSource["PROVIDED_DATA"] = "providedData";
+    FSFaceCompareSource["DOCUMENT_PHOTO"] = "documentPhoto";
+})(FSFaceCompareSource = exports.FSFaceCompareSource || (exports.FSFaceCompareSource = {}));
+var FSFaceCompareOutcome;
+(function (FSFaceCompareOutcome) {
+    FSFaceCompareOutcome["MATCH"] = "match";
+    FSFaceCompareOutcome["NO_MATCH"] = "noMatch";
+    FSFaceCompareOutcome["IMAGE_UNAVAILABLE"] = "imageUnavailable";
+})(FSFaceCompareOutcome = exports.FSFaceCompareOutcome || (exports.FSFaceCompareOutcome = {}));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@facesignai/api",
   "package-name": "@facesignai/api",
-  "version": "1.0.35",
+  "version": "1.0.37",
   "description": "Facesign API wrapper",
   "repository": {
     "type": "git",