biometry-sdk 1.0.0

package/README.md

@@ -0,0 +1,30 @@
+# biometry-web-sdk
+
+## Overview
+The `biometry-web-sdk` is a software development kit (SDK) designed to facilitate the integration of Biometry's API services.
+
+## Features
+- Consent management (For storing facial and audio biometric data)
+- Voice onboarding
+- Face onboarding
+- Face match
+- Process video
+
+## Installation
+```bash
+npm install biometry-sdk
+```
+
+## Usage
+```typescript
+import { BiometrySDK } from 'biometry-sdk';
+
+const sdk = new BiometrySDK('put your API key here');
+
+const videoFile = new File([/* file parts */], "video.mp4", {type: "video/mp4"});
+const phrase = "one two three four five six";
+const userFullName = "John Doe";
+
+const response = await sdk.processVideo(videoFile, phrase, userFullName);
+console.log(response);
+```

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { BiometrySDK } from './sdk';
+export type { ConsentResponse, VoiceOnboardingResponse, FaceOnboardingResponse, FaceMatchResponse, ProcessVideoResponse } from './types';

package/dist/sdk.d.ts

@@ -0,0 +1,63 @@
+import { ConsentResponse, FaceMatchResponse, FaceOnboardingResponse, VoiceOnboardingResponse } from "./types";
+export declare class BiometrySDK {
+    private apiKey;
+    private static readonly BASE_URL;
+    constructor(apiKey: string);
+    private request;
+    /**
+     * Submits consent for a user.
+     *
+     * @param {boolean} isConsentGiven - Indicates whether the user has given consent.
+     * @param {string} userFullName - The full name of the user giving consent.
+     * @returns {Promise<ConsentResponse>} A promise resolving to the consent response.
+     * @throws {Error} - If the user's full name is not provided or if the request fails.
+     */
+    giveConsent(isConsentGiven: boolean, userFullName: string): Promise<ConsentResponse>;
+    /**
+     * Onboards a user's voice for biometric authentication.
+     *
+     * @param {File} audio - The audio file containing the user's voice.
+     * @param {string} userFullName - The full name of the user being onboarded.
+     * @param {string} uniqueId - A unique identifier for the onboarding process.
+     * @param {string} phrase - The phrase spoken in the audio file.
+     * @param {string} [requestUserProvidedId] - An optional user-provided ID to link transactions within a unified group.
+     * @returns {Promise<VoiceOnboardingResponse>} - A promise resolving to the voice onboarding response.
+     * @throws {Error} - If required parameters are missing or the request fails.
+     */
+    onboardVoice(audio: File, userFullName: string, uniqueId: string, phrase: string, requestUserProvidedId?: string): Promise<VoiceOnboardingResponse>;
+    /**
+     * Onboards a user's face for biometric authentication.
+     *
+     * @param {File} face - Image file that contains user's face.
+     * @param {string} userFullName - The full name of the user being onboarded.
+     * @param {string} isDocument - Indicates whether the image is a document.
+     * @param {string} [requestUserProvidedId] - An optional user-provided ID to link transactions within a unified group.
+     * @returns {Promise<FaceOnboardingResponse>} - A promise resolving to the voice onboarding response.
+     * @throws {Error} - If required parameters are missing or the request fails.
+     */
+    onboardFace(face: File, userFullName: string, isDocument?: boolean, requestUserProvidedId?: string): Promise<FaceOnboardingResponse>;
+    /**
+     * Matches a user's face from video against a reference image.
+     *
+     * @param {File} image - Reference image file that contains user's face.
+     * @param {string} video - Video file that contains user's face.
+     * @param {string} userFullName - Pass the full name of end-user to process Voice and Face recognition services.
+     * @param {string} processVideoRequestId - ID from the response header of /process-video endpoint.
+     * @param {boolean} usePrefilledVideo - Pass true to use the video from the process-video endpoint.
+     * @param {string} [requestUserProvidedId] - An optional user-provided ID to link transactions within a unified group.
+     * @returns {Promise<FaceMatchResponse>} - A promise resolving to the voice onboarding response.
+     * @throws {Error} - If required parameters are missing or the request fails.
+     */
+    matchFaces(image: File, video?: File, userFullName?: string, processVideoRequestId?: string, usePrefilledVideo?: boolean, requestUserProvidedId?: string): Promise<FaceMatchResponse>;
+    /**
+     * Process the video through Biometry services to check liveness and authorize user
+     *
+     * @param {File} video - Video file that you want to process.
+     * @param {string} phrase - Set of numbers that user needs to say out loud in the video.
+     * @param {string} userFullName - Pass the full name of end-user to process Voice and Face recognition services.
+     * @param {string} requestUserProvidedId - An optional user-provided ID to link transactions within a unified group.
+     * @param {object} deviceInfo - Pass the device information in JSON format to include in transaction.
+     * @returns
+     */
+    processVideo(video: File, phrase: string, userFullName?: string, requestUserProvidedId?: string, deviceInfo?: object): Promise<any>;
+}

package/dist/types.d.ts

@@ -0,0 +1,82 @@
+export interface ConsentResponse {
+    is_consent_given: boolean;
+    user_fullname: string;
+}
+export interface VoiceOnboardingResponse {
+    status: "good" | "qafailed" | "enrolled";
+}
+export interface FaceOnboardingResponse {
+    onboard_result: {
+        code: number;
+        description: string;
+    };
+    document_auth: {
+        document_type: string;
+        country_code: string;
+        nationality_code: string;
+        nationality_name: string;
+        sex: string;
+        first_name: string;
+        father_name: string;
+        last_name: string;
+        expiry_date: string;
+        document_number: string;
+        birth_date: string;
+        portrait_photo: string;
+        signature: string;
+        document_category: string;
+        issuing_state: string;
+        front_document_type_id: string;
+        contains_rfid: boolean;
+    };
+    message: string;
+}
+export interface FaceMatchResponse {
+    code: number;
+    result: number;
+    description: string;
+    anchor: {
+        code: number;
+        description: string;
+    };
+    target: {
+        code: number;
+        description: string;
+    };
+}
+export interface ProcessVideoResponse {
+    data: {
+        "Active Speaker Detection": {
+            code: number;
+            description: string;
+            result: number;
+        };
+        "Face Liveness Detection": {
+            code: number;
+            description: string;
+            result: boolean;
+        };
+        "Face Recognition": {
+            code: number;
+            description: string;
+        };
+        "Visual Speech Recognition": {
+            code: number;
+            description: string;
+            result: string;
+        };
+        "Voice Recognition": {
+            status: string;
+            id: string;
+            score: number;
+            imposter_prob: number;
+            log_odds: string;
+        };
+    };
+    result_conditions: {
+        failed_conditions: any[];
+        failed_refer_conditions: any[];
+        status: string;
+    };
+    message: string;
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "biometry-sdk",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.2"
+  },
+  "compilerOptions": {
+    "target": "ES2017",
+    "module": "CommonJS",
+    "outDir": "./dist",
+    "strict": true,
+    "declaration": true
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ]
+}