biometry-sdk 2.3.0 → 2.3.2

package/README.md

@@ -3,15 +3,20 @@
 ## Overview
 The **Biometry Web SDK** is a software development kit designed to simplify the integration of Biometry's API services into your web application. Providing tools and utilities enables biometric enrollment (face and voice), liveness checks, and user consent.
 
+We also have UI component library for [React](https://www.npmjs.com/package/biometry-react-components). You can you this SDK in combination with it.
+
 ## Table of Contents:
 - [Installation](#installation)
 - [Basic Usage (Direct SDK Methods)](#basic-usage-direct-sdk-methods)
-  - [Consents](#1-consents)
-    - [1.1 Give Authorization Consent](#11-give-authorization-consent)
-    - [1.2 Give Storage Consent](#12-give-storage-consent)
-  - [Face Enrollment](#2-face-enrollment)
-  - [Voice Enrollment](#3-voice-enrollment)
-  - [Process Video](#4-process-video)
+  - [Sessions](#1-sessions)
+  - [Consents](#2-consents)
+    - [1.1 Give Authorization Consent](#21-give-authorization-consent)
+    - [1.2 Give Storage Consent](#22-give-storage-consent)
+  - [Face Enrollment](#3-face-enrollment)
+  - [Voice Enrollment](#4-voice-enrollment)
+  - [Process Video](#5-process-video)
+  - [Face Match](#6-face-match)
+  - [DocAuth](#7-docauth)
 - [Advanced Usage And Best Practices](#advanced-usage-and-best-practices)
   - [Typical FaceMatch Flow](#typical-facematch-flow)
   - [Error Handling](#error-handling)
@@ -38,16 +43,20 @@ const sdk = new BiometrySDK('YOUR_API_KEY');
 ### Example
 You can find an example in the example/ directory. The example demonstrates how you might integrate the BiometrySDK in a React component with the state.
 
-### 1. Sessions
+## 1. Sessions
 Session is a way to group transactions together. It is useful when you want to group transactions that are related to each other. For example, you can start a session and then use the session ID to link transactions within a unified group.
+
+Note: Use sessions generated by Biometry for API calls. Biometry sessions always have `sess_` prefix. Do not use own uuids or any other values. 
+
+Example:
   ```javascript
-  const response = await sdk.startSession();
+  const response = await sdk.startSession(); // returns uuid with `sess_` prefix
   const sessionId = response.data;
 
   const voiceFile = new File([/* voice audio bytes */], 'voice.wav', { type: 'audio/wav' });
   const faceFile = new File([/* face image bytes */], 'face.jpg', { type: 'image/jpeg' });
 
-  // Use the session ID to link transactions within a unified group
+  // Use the session ID in X-Session-Id header to link transactions within a unified group
   await sdk.giveStorageConsent(true, 'John Doe', { sessionId });
   await sdk.enrollFace(faceFile, 'John Doe', { sessionId });
   await sdk.enrollVoice(voiceFile, 'John Doe', { sessionId });
@@ -55,8 +64,8 @@ Session is a way to group transactions together. It is useful when you want to g
   // Go to the Results page in your dashboard and see the transactions grouped by the session ID
   ```
 
-### 2. Consents
-#### 2.1 Give Authorization Consent
+## 2. Consents
+### 2.1 Give Authorization Consent
 You **must** obtain user authorization consent before performing any biometric operations (Face Recognition, Voice Recognition, etc.):
   ```javascript
   await sdk.giveAuthorizationConsent(true, 'John Doe');
@@ -68,7 +77,7 @@ You **must** obtain user authorization consent before performing any biometric o
 - The first argument (`true`) indicates that the user has granted consent.
 - The second argument is the user's full name (used for record-keeping within Biometry).
 
-#### 2.2 Give Storage Consent
+### 2.2 Give Storage Consent
 You **must** obtain user consent before storing biometric data (Face Enrollment, Voice Enrollment):
   ```javascript
   await sdk.giveStorageConsent(true, 'John Doe');
@@ -80,7 +89,7 @@ You **must** obtain user consent before storing biometric data (Face Enrollment,
 - The first argument (`true`) indicates that the user has granted consent.
 - The second argument is the user's full name (used for record-keeping within Biometry).
 
-### 3. Face Enrollment
+## 3. Face Enrollment
 Enroll a user's face for future recognition or matching:
   ```javascript
   const faceFile = new File([/* face image bytes */], 'face.jpg', { type: 'image/jpeg' });
@@ -90,7 +99,7 @@ Enroll a user's face for future recognition or matching:
   console.log('Face Enrollment Response:', faceResponse);
   ```
 
-### 4. Voice Enrollment
+## 4. Voice Enrollment
 Enroll a user's voice for future authentication checks:
   ```javascript
   const voiceFile = new File([/* voice audio bytes */], 'voice.wav', { type: 'audio/wav' });
@@ -99,7 +108,7 @@ Enroll a user's voice for future authentication checks:
   const voiceResponse = await sdk.enrollVoice(voiceFile, 'John Doe');
   console.log('Voice Enrollment Response:', voiceResponse);
   ```
-### 5. Process Video
+## 5. Process Video
 Process a user's video for liveness checks and identity authorization:
   ```javascript
   const videoFile = new File([/* file parts */], 'video.mp4', { type: 'video/mp4' });
@@ -220,6 +229,7 @@ Always wrap calls in try/catch and provide user-friendly messages or fallback lo
     console.error('Face match error:', error);
   }
   ```
+  
 ### Security And Privacy Considerations
 1. **Protect Your API Key:** Avoid storing your API key in client-side code if possible. Use environment variables or server-side proxies.
 2. **Obtain Explicit Consent:** Ensure you have a transparent process for obtaining and storing user consent.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "biometry-sdk",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "type": "module",
   "main": "dist/sdk.js",
   "module": "dist/sdk.js",