@privateid/ultrapass-web-sdk 1.3.0 → 1.3.1-1300478

package/README.md

@@ -1,75 +1,75 @@
-<h1 align="center">Ultra Web SDK</h1>
-
-#### <p align="center">Powered by Private Identity® <br/> [https://privateid.com](https://privateid.com)</p>
-
-<b>  Face Validation Status </b>
-| Property | Description               |
-| -------- | ------------------------- |
-| -100     | Internal error            |
-| -2     | Too many faces (we return it if special flag is set and we detect 2 or more faces on the frame)            |
-| -1       | Invalid image             |
-| 0        | Valid face                |
-| 1        | Image spoof (Reserved Not Used) |
-| 2        | Video spoof (Reserved Not Used) |
-| 3        | Too close                 |
-| 4        | Too far                   |
-| 5        | Close to right edge       |
-| 6        | Close to left edge        |
-| 7        | Close to top edge         |
-| 8        | Close to bottom edge      |
-| 9        | Too blurry                |
-| 10       | Eye glasses detected      |
-| 11       | Facemask detected         |
-| 12       | Chin too far left         |
-| 13       | Chin too far right        |
-| 14       | Chin too far up           |
-| 15       | Chin too far down         |
-| 16       | Image too dim             |
-| 17       | Image too bright          |
-| 18       | Face low confidence value |
-| 19       | Invalid face background (Used only for FaceISO)   |
-| 20       | Eyes closed (disabled by default)               |
-| 21       | Mouth open (disabled by default)                |
-| 22       | Face tilted right         |
-| 23       | Face tilted left          |
-| 24       | Eyeglasses AND facemask detected (sort of 10 + 11 at the same time)         |
-| 25       | Face is not in the anti-spoof oval (it's used by our anti-spoof logic now)         |
-
-
-<b> Antispoof status </b>
-| Property | Description |
-|----------|----------------------------|
-| -100 | Invalid Image |
-| -6 | Skip antispoof (Skipping process alternating frames) |
-| -4 | Invalid Face |
-| -3 | Face Too Close To Edge (Reserved Not Used) |
-| -2 | Mobile Phone Detected (Reserved Not Used) |
-| -1 | No Face Detected |
-| 0 | Real |
-| 1 | Spoof Detected |
-
-<b> Document Validation Status </b>
-| Property | Description |
-|----------|----------------------------|
-| -2 | Internal Error |
-| -1 | Document Not Detected |
-| 0 | Valid Document |
-| 1 | Low confidence score (Reserved Not Used) |
-| 2 | Document is blurry |
-| 3 | Document too close |
-| 4 | Document too far |
-| 5 | Document too far left |
-| 6 | Document too far right |
-| 7 | Document too far up |
-| 8 | Document too far down |
-| 9 | Fingers over document |
-
-
-<b> Barcode Validation Status </b>
-| Property |	Description |
-|----------|----------------------------|
-| -1 | Barcode not detected |
-| 0 | Barcode found and parsed |
-| 3 | Unsupported barcode detected |
-| 4 | Unable to parse barcode data |
-
+<h1 align="center">Ultra Web SDK</h1>
+
+#### <p align="center">Powered by Private Identity® <br/> [https://privateid.com](https://privateid.com)</p>
+
+<b>  Face Validation Status </b>
+| Property | Description               |
+| -------- | ------------------------- |
+| -100     | Internal error            |
+| -2     | Too many faces (we return it if special flag is set and we detect 2 or more faces on the frame)            |
+| -1       | Invalid image             |
+| 0        | Valid face                |
+| 1        | Image spoof (Reserved Not Used) |
+| 2        | Video spoof (Reserved Not Used) |
+| 3        | Too close                 |
+| 4        | Too far                   |
+| 5        | Close to right edge       |
+| 6        | Close to left edge        |
+| 7        | Close to top edge         |
+| 8        | Close to bottom edge      |
+| 9        | Too blurry                |
+| 10       | Eye glasses detected      |
+| 11       | Facemask detected         |
+| 12       | Chin too far left         |
+| 13       | Chin too far right        |
+| 14       | Chin too far up           |
+| 15       | Chin too far down         |
+| 16       | Image too dim             |
+| 17       | Image too bright          |
+| 18       | Face low confidence value |
+| 19       | Invalid face background (Used only for FaceISO)   |
+| 20       | Eyes closed (disabled by default)               |
+| 21       | Mouth open (disabled by default)                |
+| 22       | Face tilted right         |
+| 23       | Face tilted left          |
+| 24       | Eyeglasses AND facemask detected (sort of 10 + 11 at the same time)         |
+| 25       | Face is not in the anti-spoof oval (it's used by our anti-spoof logic now)         |
+
+
+<b> Antispoof status </b>
+| Property | Description |
+|----------|----------------------------|
+| -100 | Invalid Image |
+| -6 | Skip antispoof (Skipping process alternating frames) |
+| -4 | Invalid Face |
+| -3 | Face Too Close To Edge (Reserved Not Used) |
+| -2 | Mobile Phone Detected (Reserved Not Used) |
+| -1 | No Face Detected |
+| 0 | Real |
+| 1 | Spoof Detected |
+
+<b> Document Validation Status </b>
+| Property | Description |
+|----------|----------------------------|
+| -2 | Internal Error |
+| -1 | Document Not Detected |
+| 0 | Valid Document |
+| 1 | Low confidence score (Reserved Not Used) |
+| 2 | Document is blurry |
+| 3 | Document too close |
+| 4 | Document too far |
+| 5 | Document too far left |
+| 6 | Document too far right |
+| 7 | Document too far up |
+| 8 | Document too far down |
+| 9 | Fingers over document |
+
+
+<b> Barcode Validation Status </b>
+| Property |	Description |
+|----------|----------------------------|
+| -1 | Barcode not detected |
+| 0 | Barcode found and parsed |
+| 3 | Unsupported barcode detected |
+| 4 | Unable to parse barcode data |
+

package/dist/apiUtils.d.ts

@@ -1,46 +1,46 @@
-export declare const createDocumentDL: ({ baseUrl, token }: {
-    baseUrl: string;
-    token: string;
-}) => Promise<any>;
-export declare const updateDocumentDetails: ({ baseUrl, token, documentId, params, }: {
-    baseUrl: string;
-    token: string;
-    documentId: string;
-    params: {
-        encryptedKey: string;
-        iv: string;
-        gcmAad: string;
-        gcmTag: string;
-        encrptedMessage: string;
-    };
-}) => Promise<any>;
-export declare enum documentImageTypeEnum {
-    FRONTDLORIGINAL = "front",
-    FRONTDLHEADSHOT = "front_mugshot",
-    FRONTDLCROPPED = "front_cropped_document",
-    BACKDLORIGINAL = "back",
-    BACKDLCROPPED = "back_cropped_document",
-    BACKDLBARCODE = "back_barcode"
-}
-interface uploadDocumentImageParams {
-    type: documentImageTypeEnum;
-    data: string;
-}
-export declare const uploadDocumentImage: ({ baseUrl, token, documentId, params, }: {
-    baseUrl: string;
-    token: string;
-    documentId: string;
-    params: uploadDocumentImageParams;
-}) => Promise<any>;
-export declare const updateUserDetails: ({ baseUrl, token, params, }: {
-    baseUrl: string;
-    token: string;
-    params: {
-        encryptedKey: string;
-        iv: string;
-        gcmAad: string;
-        gcmTag: string;
-        encrptedMessage: string;
-    };
-}) => Promise<any>;
-export {};
+export declare const createDocumentDL: ({ baseUrl, token }: {
+    baseUrl: string;
+    token: string;
+}) => Promise<any>;
+export declare const updateDocumentDetails: ({ baseUrl, token, documentId, params, }: {
+    baseUrl: string;
+    token: string;
+    documentId: string;
+    params: {
+        encryptedKey: string;
+        iv: string;
+        gcmAad: string;
+        gcmTag: string;
+        encrptedMessage: string;
+    };
+}) => Promise<any>;
+export declare enum documentImageTypeEnum {
+    FRONTDLORIGINAL = "front",
+    FRONTDLHEADSHOT = "front_mugshot",
+    FRONTDLCROPPED = "front_cropped_document",
+    BACKDLORIGINAL = "back",
+    BACKDLCROPPED = "back_cropped_document",
+    BACKDLBARCODE = "back_barcode"
+}
+interface uploadDocumentImageParams {
+    type: documentImageTypeEnum;
+    data: string;
+}
+export declare const uploadDocumentImage: ({ baseUrl, token, documentId, params, }: {
+    baseUrl: string;
+    token: string;
+    documentId: string;
+    params: uploadDocumentImageParams;
+}) => Promise<any>;
+export declare const updateUserDetails: ({ baseUrl, token, params, }: {
+    baseUrl: string;
+    token: string;
+    params: {
+        encryptedKey: string;
+        iv: string;
+        gcmAad: string;
+        gcmTag: string;
+        encrptedMessage: string;
+    };
+}) => Promise<any>;
+export {};