biometry-sdk 2.3.5 → 2.3.6

package/README.md

@@ -1,274 +1,702 @@
-# biometry-sdk
-
-## 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)
-  - [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)
-  - [Header Retrieval](#header-retrieval)
-  - [Security And Privacy Considerations](#security-and-privacy-considerations)
-- [License](#license)
-- [More Information](#more-information)
-- [Quick Reference](#quick-reference)
-
-## Installation
-Install the Biometry Web SDK via npm:
+# Biometry Web SDK
+
+The official JavaScript/TypeScript SDK for integrating [Biometry](https://biometrysolutions.com) identity verification services into web applications. Provides a simple, promise-based API for biometric enrollment, liveness detection, face matching, document authentication, and consent management.
+
+> **Companion library:** For pre-built React UI components (camera capture, liveness screens, etc.), see [biometry-react-components](https://www.npmjs.com/package/biometry-react-components). Use it alongside this SDK for a faster integration.
+
+## Features
+
+- **Session management** — group related transactions under a single session ID
+- **Consent management** — collect authorization and storage consent (required before biometric operations)
+- **Face enrollment** — register a user's face from a photo or ID document
+- **Voice enrollment** — register a user's voice for speaker verification
+- **Video processing** — liveness detection, active speaker detection, face recognition, voice recognition, and visual speech recognition in one call
+- **Auto-enrollment** — automatic face and voice enrollment during video processing when both consents are given
+- **Face matching** — compare a reference image against a video to verify identity
+- **Document authentication** — extract and validate data from ID documents (passports, ID cards, etc.)
+- **Full TypeScript support** — ships with complete type definitions
+- **Framework-agnostic** — works with React, Angular, Vue, vanilla JS, or any web framework
+
+## Getting Started
+
+### Prerequisites
+
+- An active Biometry project with an **API key** (obtain one from the [Biometry Dashboard](https://console.biometrysolutions.com))
+- Node.js 16+ (for npm-based projects) or any modern browser with ES module support
+
+### Installation
+
 ```bash
 npm install biometry-sdk
 ```
 
-## Basic Usage (Direct SDK Methods)
-After installing, import and instantiate the BiometrySDK:
+### Initialization
+
 ```typescript
 import { BiometrySDK } from 'biometry-sdk';
 
-// Initialize the SDK with your API key
 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
-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(); // 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 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 });
-
-  // Go to the Results page in your dashboard and see the transactions grouped by the session ID
-  ```
-
-## 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');
-  // or
-  sdk.giveAuthorizationConsent(true, 'John Doe').then(() => {
-    console.log('Consent given');
-  });
-  ```
-- 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
-You **must** obtain user consent before storing biometric data (Face Enrollment, Voice Enrollment):
-  ```javascript
-  await sdk.giveStorageConsent(true, 'John Doe');
-  // or
-  sdk.giveStorageConsent(true, 'John Doe').then(() => {
-    console.log('Consent given');
-  });
-  ```
-- 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
-Enroll a user's face for future recognition or matching:
-  ```javascript
-  const faceFile = new File([/* face image bytes */], 'face.jpg', { type: 'image/jpeg' });
-  
-  await sdk.giveStorageConsent(true, 'John Doe');
-  const faceResponse = await sdk.enrollFace(faceFile, 'John Doe');
-  console.log('Face Enrollment Response:', faceResponse);
-  ```
-
-## 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' });
-
-  await sdk.giveStorageConsent(true, 'John Doe');
-  const voiceResponse = await sdk.enrollVoice(voiceFile, 'John Doe');
-  console.log('Voice Enrollment Response:', voiceResponse);
-  ```
-## 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' });
-  const phrase = "one two three four five six";
-  const userFullName = 'John Doe';
-  
-  await sdk.giveAuthorizationConsent(true, userFullName);
-  
-  try {
-    const response = await sdk.processVideo(videoFile, phrase, userFullName);
-    console.log('Process Video Response:', response);
-  } catch (error) {
-    console.error('Error processing video:', error);
-  }
-  ```
-
-### 6. Face match
-Use matchFaces to compare a reference image (e.g., a document or a captured selfie) with a face from a video:
-  ```javascript
-  const faceFile = new File([/* face image bytes */], 'face.jpg', { type: 'image/jpeg' });
-  const videoFile = new File([/* file parts */], 'video.mp4', { type: 'video/mp4' });
-  const userFullName = 'John Doe';
-
-  const faceMatchResponse = await sdk.faceMatch(
-    faceFile,
-    videoFile,
-    userFullName
-  );
-  ```
-
-You can also reuse a video that was previously processed with the `processVideo` method by passing the same sessionId:
-  ```javascript
-  const sessionId = await sdk.startSession();
-
-  // First, process a video with a sessionId
-  const processVideoResponse = await sdk.processVideo(videoFile, phrase, userFullName, { sessionId });
-  
-  // Later, reuse the same video for face matching by providing the sessionId
-  const faceMatchResponse = await sdk.faceMatch(
-    faceFile,
-    null, // No need to pass the video file again
-    userFullName,
-    true, // usePrefilledVideo
-    { sessionId }
-  );
-  ```
-
-### 7. DocAuth
-DocAuth is a way to authenticate a user's document. It is useful when you want to authenticate a user's document.
-  ```javascript
-  const sessionId = await sdk.startSession();
-
-  const documentFile = new File([/* file parts */], 'document.jpg', { type: 'image/jpeg' });
-  const userFullName = 'John Doe';
-    
-  await sdk.giveAuthorizationConsent(true, userFullName, { sessionId });
-    
-  try {
-    const response = await sdk.checkDocAuth(documentFile, userFullName, { sessionId, inHouseCheck: true });
-    console.log('DocAuth Response:', response);
-  } catch (error) {
-    console.error('Error checking document:', error);
-  }
-  ```
-
-## Advanced Usage And Best Practices
-### Typical FaceMatch Flow
-One common advanced scenario involves document authentication in enrollment face and face matching:
-1. Face Enrollment: Capture the user's live face or the user uploads a picture of their identity document (front side with the face)
-2. Process Video: Capture the user's live face
-3. Face Match: Compare the extracted face from the document with the user's live face to verify identity.
-
-Below is a possible flow (method names in your SDK may vary slightly depending on your integration setup):
-  ```javascript
-  // 1. Acquire user storage consent
-  await sdk.giveStorageConsent(true, userFullName);
-  
-  // 2. Enroll or capture the user's face
-  //    (Either using enrollFace or processVideo, depending on your user flow)
-  const userFaceFile = new File([/* user selfie bytes */], 'image.jpg', { type: 'image/jpeg' });
-  const userVideoFile = new File([/* user selfie bytes */], 'video.mp4', { type: 'video/*' });
-  const enrollResponse = await sdk.enrollFace(userFaceFile, userFullName);
-  
-  // 3. Acquire user authorization consent. It's required to use enrolled face for using biometric data.
-  await sdk.giveAuthorizationConsent(true, userFullName);
-
-  // 4. Face Match (Compare video face with user's enrolled face)
-  const faceMatchResponse = await sdk.faceMatch(
-    userFaceFile,
-    userVideoFile,
-    userFullName
-  );
-  
-  // 5. Evaluate the faceMatch result
-  if (faceMatchResponse.matchResult === 'match') {
-    console.log('User video face matches user's live face. Identity verified!');
-  } else {
-    console.log('User video face does NOT match. Additional verification needed.');
-  }
-  ```
-
-### Error Handling
-All SDK calls can throw errors for various reasons:
-- Network/Connection Issues
-- Invalid File Types
-- No Face Detected (Face Enrollment)
-- No Speech Detected (Voice Enrollment)
-- Multiple Faces Detected (Face Enrollment)
-- Liveness Check Failure (Process Video)
-
-Always wrap calls in try/catch and provide user-friendly messages or fallback logic.
-  ```javascript
-  try {
-    const response = await sdk.faceMatch(...);
-    // handle success
-  } catch (error) {
-    // handle error
-    console.error('Face match error:', error);
-  }
-  ```
-
-### Header Retrieval
-In addition to the response body, all SDK calls also return response headers.  
-This is useful for retrieving metadata such as request and session IDs, or debugging information.
-
-Each API call returns an object of type:
-
-  ```ts
-  export interface ApiResponse<T> {
-    body: T;
-    headers: Record<string, string>;
-  }
-  ```
-  For example, when calling the processVideo method, you can access both the response data and headers:
-  ```ts
-  try {
-    const response = await sdk.processVideo(videoFile, "12345678", "John Doe");
-
-    // Access the response body
-    console.log("Process video result:", response.body);
-
-    // Access headers (e.g., request ID)
-    console.log("Request ID:", response.headers["x-request-id"]);
-  } catch (error) {
-    console.error("Process video failed:", error);
-  }
-  ```
-  This pattern applies to all SDK methods, so you can always extract useful metadata from headers in addition to the main response.
-
-  
-### 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.
-3. **Data Minimization:** Only store data that is required for your use case.
-4. **Regulatory Compliance:** Check local regulations (GDPR, CCPA, etc.) for storing and processing biometric data.
+The API key is used as a Bearer token for all requests to the Biometry API. An error is thrown if the key is empty.
+
+> **Security:** Never hardcode API keys in client-side code shipped to production. Use environment variables or a server-side proxy to keep your key private.
+
+## Response Structure
+
+All gateway API responses follow a standard envelope format:
+
+```json
+{
+  "data": { ... },
+  "scoring_result": "pass" | "fail" | "refer" | { ... },
+  "score": 0.95,
+  "decision_reasons": ["reason1", "reason2"],
+  "message": "human-readable status message"
+}
+```
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `data` | `object` | The primary response payload (service results, extracted data, etc.) |
+| `scoring_result` | `string \| object` | Scoring outcome — `"pass"`, `"fail"`, or `"refer"` for video processing and document auth; a detailed scoring map for face matching |
+| `score` | `number` | Numeric confidence score (0–1), present on video processing responses |
+| `decision_reasons` | `string[]` | Reasons for a fail/refer decision (e.g. `["liveness_failed"]`) |
+| `message` | `string` | Human-readable status message |
+
+The SDK wraps this in an `ApiResponse<T>` object that also includes the HTTP response headers:
+
+```typescript
+interface ApiResponse<T> {
+  body: T;                          // Response payload (the envelope above)
+  headers: Record<string, string>;  // HTTP response headers
+}
+```
+
+Not all fields are present on every response — only relevant fields are included (empty/zero fields are omitted).
+
+## Usage
+
+### Sessions
+
+Sessions group related transactions together so they appear as a single flow in the Biometry Dashboard.
+
+```typescript
+const session = await sdk.startSession();
+const sessionId = session.body.data; // "sess_xxxxxxxx-xxxx-..."
+
+// Pass sessionId to subsequent calls to link them together
+await sdk.giveStorageConsent(true, 'Jane Doe', { sessionId });
+await sdk.enrollFace(faceFile, 'Jane Doe', false, { sessionId });
+```
+
+### Consent
+
+Consent must be collected **before** performing biometric operations. There are two types:
+
+| Type | Required before | Method |
+|------|----------------|--------|
+| **Authorization** | Face recognition, voice recognition, face matching | `giveAuthorizationConsent()` |
+| **Storage** | Face enrollment, voice enrollment | `giveStorageConsent()` |
+
+```typescript
+// Authorization consent — required for recognition/verification operations
+await sdk.giveAuthorizationConsent(true, 'Jane Doe');
+
+// Storage consent — required for enrollment operations
+await sdk.giveStorageConsent(true, 'Jane Doe');
+```
+
+Both methods accept optional `sessionId` and `deviceInfo`:
+
+```typescript
+await sdk.giveAuthorizationConsent(true, 'Jane Doe', {
+  sessionId: 'sess_abc123',
+  deviceInfo: { os: 'iOS', browser: 'Safari' },
+});
+```
+
+> **Important — Consent and video processing:** The `processVideo` endpoint does **not** reject requests without consent. Instead, it silently removes services that require authorization consent (face recognition, voice recognition) and processes only the remaining services (liveness detection, active speaker detection, visual speech recognition). When services are removed, the response includes the header `X-Removed-Services: true`. Always collect consent before calling `processVideo` to ensure all services run.
+
+> **Important — Auto-enrollment:** When **both** authorization and storage consent are given, `processVideo` will automatically enroll the user's face and voice in the background (if not already enrolled). The response header `X-Auto-Enroll: true` is set when this occurs. See [Auto-Enrollment](#auto-enrollment) for details.
+
+### Face Enrollment
+
+Register a user's face for future matching. Requires **storage consent** first.
+
+```typescript
+const faceFile = new File([imageBytes], 'face.jpg', { type: 'image/jpeg' });
+
+await sdk.giveStorageConsent(true, 'Jane Doe');
+const response = await sdk.enrollFace(faceFile, 'Jane Doe');
+
+// Response envelope:
+// {
+//   "data": {
+//     "enrollment_result": { "code": 0, "description": "Face enrolled successfully" },
+//     "document_auth": null
+//   },
+//   "message": "face enrolled successfully"
+// }
+
+console.log(response.body.data.enrollment_result);
+// { code: 0, description: "Face enrolled successfully" }
+```
+
+If enrolling from an ID document image (e.g. passport photo), set `isDocument` to `true`. This improves face detection accuracy for document photos:
+
+```typescript
+const response = await sdk.enrollFace(documentImage, 'Jane Doe', true);
+```
+
+When `isDocument` is `true`, the response may include `document_auth` with extracted document data alongside the enrollment result.
+
+An `enrollment_result.code` of `0` means success. Non-zero codes indicate a failure (e.g. no face detected, multiple faces detected).
+
+### Voice Enrollment
+
+Register a user's voice for speaker verification. Requires **storage consent** first.
+
+```typescript
+const audioFile = new File([audioBytes], 'voice.wav', { type: 'audio/wav' });
+
+await sdk.giveStorageConsent(true, 'Jane Doe');
+const response = await sdk.enrollVoice(
+  audioFile,
+  'Jane Doe',
+  'jane-doe-id',    // unique identifier
+  'one two three'   // the phrase spoken in the audio
+);
+
+// Response envelope:
+// {
+//   "data": {
+//     "status": "good",
+//     "qa_combined": { ... },
+//     "qa_list": [...]
+//   },
+//   "message": "voice registered successfully"
+// }
+
+console.log(response.body.data.status); // "good" | "qafailed" | "enrolled" | "error"
+```
+
+> **Note:** The voice enrollment identifier is derived from the `userFullName` parameter (spaces are replaced with underscores). For example, `'Jane Doe'` becomes `Jane_Doe` as the enrollment ID on the backend. The `uniqueId` parameter is sent in the request but the server-side identifier is derived from the user's full name.
+
+### Video Processing (Liveness & Recognition)
+
+Process a video to perform up to five biometric checks in a single request:
+
+1. **Face Liveness Detection** — determines if the face in the video is a real person (not a photo/screen replay)
+2. **Active Speaker Detection** — verifies the person is actively speaking
+3. **Visual Speech Recognition** — reads lips to verify the spoken phrase matches
+4. **Face Recognition** — identifies the face against enrolled faces (requires authorization consent)
+5. **Voice Recognition** — verifies the speaker's voice against enrolled voiceprints (requires authorization consent)
+
+```typescript
+const videoFile = new File([videoBytes], 'video.mp4', { type: 'video/mp4' });
+
+await sdk.giveAuthorizationConsent(true, 'Jane Doe');
+const response = await sdk.processVideo(videoFile, '12345678', 'Jane Doe');
+
+// Response envelope:
+// {
+//   "data": {
+//     "Face Liveness Detection": { "code": 0, "description": "Real face detected", "result": true },
+//     "Active Speaker Detection": { "code": 0, "description": "Active speaker detected", "result": 1 },
+//     "Visual Speech Recognition": { "code": 0, "description": "...", "result": "12345678" },
+//     "Face Recognition": { "code": 0, "description": "Face identified" },
+//     "Voice Recognition": { "status": "good", "id": "Jane_Doe", "score": 0.92, ... }
+//   },
+//   "scoring_result": "pass",
+//   "score": 0.95,
+//   "decision_reasons": [],
+//   "message": "video processed successfully"
+// }
+
+console.log(response.body.scoring_result); // "pass" | "fail" | "refer"
+console.log(response.body.data['Face Liveness Detection'].result); // true or false
+console.log(response.body.data['Visual Speech Recognition'].result); // the recognized phrase
+```
+
+The `phrase` parameter is a set of digits the user speaks aloud in the video (e.g. `'12345678'`). This is used for visual speech recognition and voice verification.
+
+The `scoring_result` field indicates the overall outcome:
+- `"pass"` — all checks passed
+- `"fail"` — one or more checks failed
+- `"refer"` — needs manual review
+
+When the result is `"fail"` or `"refer"`, check `decision_reasons` for specific failure causes.
+
+#### Auto-Enrollment
+
+When **both** authorization consent and storage consent have been given for the user, `processVideo` automatically enrolls the user's face and voice in the background. This is useful for registration flows where you want to verify liveness and enroll in a single step.
+
+Auto-enrollment behavior:
+- **Face**: Enrolled from the video if the user's face is not already enrolled
+- **Voice**: Enrolled from the video audio if the user's voice is not already enrolled for the given phrase
+- **Response header**: `X-Auto-Enroll: true` is set when auto-enrollment is triggered
+- **Non-blocking**: Enrollment happens asynchronously and does not affect the video processing response
+
+```typescript
+// Collect both consents to enable auto-enrollment
+await sdk.giveStorageConsent(true, 'Jane Doe', { sessionId });
+await sdk.giveAuthorizationConsent(true, 'Jane Doe', { sessionId });
+
+// processVideo will now auto-enroll face and voice in the background
+const response = await sdk.processVideo(videoFile, '12345678', 'Jane Doe', { sessionId });
+
+// Check if auto-enrollment was triggered
+if (response.headers['x-auto-enroll'] === 'true') {
+  console.log('Face and voice enrolled automatically');
+}
+```
+
+> **Tip:** If you only need liveness detection (without face/voice recognition), you can call `processVideo` without providing a `userFullName`. Services that require consent (face recognition, voice recognition) will be skipped.
+
+### Face Matching
+
+Compare a reference image (selfie, ID photo, etc.) against a face from a video to verify identity.
+
+**Option A — Provide both image and video:**
+
+```typescript
+const imageFile = new File([imgBytes], 'face.jpg', { type: 'image/jpeg' });
+const videoFile = new File([vidBytes], 'video.mp4', { type: 'video/mp4' });
+
+const response = await sdk.matchFaces(imageFile, videoFile, 'Jane Doe');
+
+// Response envelope:
+// {
+//   "data": {
+//     "code": 0,
+//     "result": 1,
+//     "description": "Successful check",
+//     "anchor": { "code": 0, "description": "One face found in the image" },
+//     "target": { "code": 0, "description": "One face found in the video" }
+//   },
+//   "scoring_result": { "status": "pass", ... },
+//   "decision_reasons": [],
+//   "message": "faces match result is here"
+// }
+
+console.log(response.body.data.result);      // 1 = match, 0 = no match
+console.log(response.body.data.description); // "Successful check"
+```
+
+| `data.result` | Meaning |
+|-------|---------|
+| `1` | Faces match |
+| `0` | Faces do not match |
+
+The `anchor` field describes the face detected in the reference image, and `target` describes the face detected in the video. A `code` of `0` means a face was successfully found.
+
+**Option B — Reuse video from a previous `processVideo` call:**
+
+If you already called `processVideo` with a `sessionId`, you can skip uploading the video again:
+
+```typescript
+const session = await sdk.startSession();
+const sessionId = session.body.data;
+
+// Step 1: Process video within the session
+await sdk.processVideo(videoFile, '12345678', 'Jane Doe', { sessionId });
+
+// Step 2: Match faces reusing the same video
+const response = await sdk.matchFaces(
+  imageFile,       // Reference image
+  undefined,       // No video file needed
+  'Jane Doe',
+  true,            // usePrefilledVideo
+  { sessionId }    // Same session ID
+);
+```
+
+### Document Authentication
+
+Extract and validate information from identity documents (passports, ID cards, driver's licenses). Only JPG, JPEG, and PNG images are accepted.
+
+```typescript
+const docFile = new File([docBytes], 'passport.jpg', { type: 'image/jpeg' });
+
+await sdk.giveAuthorizationConsent(true, 'Jane Doe', { sessionId });
+const response = await sdk.checkDocAuth(docFile, 'Jane Doe', {
+  sessionId,
+  inHouseCheck: true,
+});
+
+// Response envelope:
+// {
+//   "data": {
+//     "document_type": "National Identification Card",
+//     "first_name": "JANE",
+//     "last_name": "DOE",
+//     "birth_date": "1990-01-01",
+//     "document_number": "AB1234567",
+//     "country_code": "AUS",
+//     "sex": "FEMALE",
+//     "expiry_date": "2028-08-01",
+//     "portrait_photo": "<base64>",
+//     "face_image_base64": "<base64>",
+//     "current_result": "Passed",
+//     ...
+//   },
+//   "scoring_result": "pass",
+//   "message": "Document uploaded successfully, looks like it's authentic"
+// }
+
+const doc = response.body.data;
+console.log(doc.first_name);          // "JANE" (uppercase)
+console.log(doc.last_name);           // "DOE" (uppercase)
+console.log(doc.document_number);     // "AB1234567"
+console.log(doc.document_type);       // "National Identification Card"
+console.log(doc.portrait_photo);      // Base64-encoded photo from document OCR
+console.log(doc.face_image_base64);   // Base64-encoded cropped face image
+```
+
+> **Note:** `first_name` and `last_name` are returned in uppercase. The `portrait_photo` field contains the photo extracted via OCR/field parsing, while `face_image_base64` contains a cropped face image detected and extracted from the document.
+
+The `scoring_result` field indicates document validation outcome: `"pass"` if the document looks authentic, `"fail"` otherwise.
+
+The `inHouseCheck` option uses Biometry's in-house document verification (GPT + ML-based). When set to `false` (or omitted), the external IDScan verification service is used instead. The in-house check is the default and recommended option.
+
+## Common Flows
+
+### Identity Verification (KYC)
+
+A typical identity verification flow combines consent, liveness, and face matching:
+
+```typescript
+const sdk = new BiometrySDK('YOUR_API_KEY');
+const session = await sdk.startSession();
+const sessionId = session.body.data;
+const userName = 'Jane Doe';
+
+// 1. Collect both consents
+await sdk.giveStorageConsent(true, userName, { sessionId });
+await sdk.giveAuthorizationConsent(true, userName, { sessionId });
+
+// 2. Process live video for liveness + auto-enrollment
+//    (auto-enrolls face and voice since both consents are given)
+const liveVideo = new File([videoBytes], 'video.mp4', { type: 'video/mp4' });
+const videoResult = await sdk.processVideo(liveVideo, '12345678', userName, { sessionId });
+
+if (videoResult.body.scoring_result !== 'pass') {
+  console.error('Liveness check failed:', videoResult.body.decision_reasons);
+  return;
+}
+
+// 3. Match the ID photo against the live video (reusing video from step 2)
+const idPhoto = new File([idBytes], 'id.jpg', { type: 'image/jpeg' });
+const matchResult = await sdk.matchFaces(
+  idPhoto, undefined, userName, true, { sessionId }
+);
+
+if (matchResult.body.data.result === 1) {
+  console.log('Identity verified!');
+} else {
+  console.log('Face mismatch — verification failed');
+}
+```
+
+> **Note:** In this flow, explicit face enrollment (step 2 from the previous version) is no longer needed. Since both consents are given, `processVideo` auto-enrolls the user's face and voice in the background. You can proceed directly to face matching.
+
+### Document-Only Verification
+
+For flows that only need document data extraction:
+
+```typescript
+const sdk = new BiometrySDK('YOUR_API_KEY');
+
+await sdk.giveAuthorizationConsent(true, 'Jane Doe');
+
+const result = await sdk.checkDocAuth(documentFile, 'Jane Doe', {
+  inHouseCheck: true,
+});
+
+const doc = result.body.data;
+console.log(`${doc.first_name} ${doc.last_name}`);
+console.log(`DOB: ${doc.birth_date}`);
+console.log(`Document: ${doc.document_number}`);
+console.log(`Valid: ${result.body.scoring_result}`); // "pass" or "fail"
+```
+
+### Full KYC with Document Authentication
+
+Combine document authentication with liveness verification and face matching for a comprehensive KYC flow:
+
+```typescript
+const sdk = new BiometrySDK('YOUR_API_KEY');
+const session = await sdk.startSession();
+const sessionId = session.body.data;
+const userName = 'Jane Doe';
+
+// 1. Collect both consents
+await sdk.giveStorageConsent(true, userName, { sessionId });
+await sdk.giveAuthorizationConsent(true, userName, { sessionId });
+
+// 2. Authenticate the ID document
+const docImage = new File([docBytes], 'passport.jpg', { type: 'image/jpeg' });
+const docResult = await sdk.checkDocAuth(docImage, userName, {
+  sessionId,
+  inHouseCheck: true,
+});
+
+if (docResult.body.scoring_result !== 'pass') {
+  console.error('Document authentication failed');
+  return;
+}
+
+// 3. Process live video (liveness + auto-enrollment)
+const liveVideo = new File([videoBytes], 'video.mp4', { type: 'video/mp4' });
+const videoResult = await sdk.processVideo(liveVideo, '12345678', userName, { sessionId });
+
+if (videoResult.body.scoring_result !== 'pass') {
+  console.error('Liveness check failed');
+  return;
+}
+
+// 4. Match document photo against live video
+const matchResult = await sdk.matchFaces(
+  docImage, undefined, userName, true, { sessionId }
+);
+
+if (matchResult.body.data.result === 1) {
+  console.log('KYC complete — identity verified!');
+} else {
+  console.log('Face mismatch — document does not match live video');
+}
+```
+
+## API Reference
+
+### `new BiometrySDK(apiKey)`
+
+Creates a new SDK instance.
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `apiKey` | `string` | Yes | Your Biometry project API key |
+
+---
+
+### `startSession()`
+
+Starts a new session for grouping transactions.
+
+**Returns:** `Promise<ApiResponse<SessionResponse>>`
+
+```typescript
+// SessionResponse
+{ data: string; message: string }
+```
+
+---
+
+### `giveAuthorizationConsent(isConsentGiven, userFullName, props?)`
+
+Submits authorization consent. Required before recognition and verification operations.
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `isConsentGiven` | `boolean` | Yes | Whether the user granted consent |
+| `userFullName` | `string` | Yes | User's full name for record-keeping |
+| `props.sessionId` | `string` | No | Session ID to link with |
+| `props.deviceInfo` | `object` | No | Device metadata |
+
+**Returns:** `Promise<ApiResponse<ConsentResponse>>`
+
+---
+
+### `giveStorageConsent(isStorageConsentGiven, userFullName, props?)`
+
+Submits storage consent. Required before enrollment operations.
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `isStorageConsentGiven` | `boolean` | Yes | Whether the user granted storage consent |
+| `userFullName` | `string` | Yes | User's full name for record-keeping |
+| `props.sessionId` | `string` | No | Session ID to link with |
+| `props.deviceInfo` | `object` | No | Device metadata |
+
+**Returns:** `Promise<ApiResponse<ConsentResponse>>`
+
+---
+
+### `enrollFace(face, userFullName, isDocument?, props?)`
+
+Enrolls a user's face for biometric authentication.
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `face` | `File` | Yes | Image file containing the face |
+| `userFullName` | `string` | Yes | User's full name |
+| `isDocument` | `boolean` | No | Set `true` if image is from an ID document |
+| `props.sessionId` | `string` | No | Session ID to link with |
+| `props.deviceInfo` | `object` | No | Device metadata |
+
+**Returns:** `Promise<ApiResponse<FaceEnrollmentResponse>>`
+
+Response `data` contains:
+- `enrollment_result.code` — `0` for success, non-zero for failure
+- `enrollment_result.description` — human-readable result
+- `document_auth` — extracted document data (when `isDocument` is `true`)
+
+---
+
+### `enrollVoice(audio, userFullName, uniqueId, phrase, props?)`
+
+Enrolls a user's voice for speaker verification.
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `audio` | `File` | Yes | Audio file with the user's voice |
+| `userFullName` | `string` | Yes | User's full name (also used as the enrollment identifier) |
+| `uniqueId` | `string` | Yes | Unique identifier for the enrollment |
+| `phrase` | `string` | Yes | The phrase spoken in the audio |
+| `props.sessionId` | `string` | No | Session ID to link with |
+| `props.deviceInfo` | `object` | No | Device metadata |
+
+**Returns:** `Promise<ApiResponse<VoiceEnrollmentResponse>>`
+
+Response `data` contains:
+- `status` — `"good"` (accepted), `"enrolled"` (fully enrolled), `"qafailed"` (quality check failed), or `"error"`
+- `qa_combined` — combined quality assessment results
+- `qa_list` — per-file quality results
+
+---
+
+### `processVideo(video, phrase, userFullName?, props?)`
+
+Processes a video for liveness detection, face recognition, active speaker detection, visual speech recognition, and voice recognition.
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `video` | `File` | Yes | Video file to process |
+| `phrase` | `string` | Yes | Digits the user speaks in the video |
+| `userFullName` | `string` | No | User's full name (required for face/voice recognition) |
+| `props.sessionId` | `string` | No | Session ID to link with |
+| `props.deviceInfo` | `object` | No | Device metadata |
+
+**Returns:** `Promise<ApiResponse<ProcessVideoResponse>>`
+
+The `scoring_result` field indicates the overall outcome: `"pass"`, `"fail"`, or `"refer"` (needs manual review).
+
+When both authorization and storage consent are given, face and voice are automatically enrolled in the background. The response header `X-Auto-Enroll: true` is set when auto-enrollment occurs.
+
+---
+
+### `matchFaces(image, video?, userFullName?, usePrefilledVideo?, props?)`
+
+Compares a reference image against a face from a video.
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `image` | `File` | Yes | Reference image containing a face |
+| `video` | `File` | No | Video file with a face to compare. Required unless `usePrefilledVideo` is `true` |
+| `userFullName` | `string` | No | User's full name |
+| `usePrefilledVideo` | `boolean` | No | Reuse video from a previous `processVideo` call in the same session |
+| `props.sessionId` | `string` | Conditional | Required if `usePrefilledVideo` is `true` |
+| `props.deviceInfo` | `object` | No | Device metadata |
+
+**Returns:** `Promise<ApiResponse<FaceMatchResponse>>`
+
+Response `data` contains:
+- `result` — `1` for match, `0` for no match
+- `code` — `0` for successful comparison
+- `description` — human-readable result
+- `anchor` — face detection result for the reference image
+- `target` — face detection result for the video
+
+---
+
+### `checkDocAuth(document, userFullName, props?)`
+
+Authenticates an identity document and extracts its data.
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `document` | `File` | Yes | Document image file (JPG, JPEG, or PNG only) |
+| `userFullName` | `string` | Yes | User's full name |
+| `props.sessionId` | `string` | No | Session ID to link with |
+| `props.deviceInfo` | `object` | No | Device metadata |
+| `props.inHouseCheck` | `boolean` | No | Use in-house document verification (default behavior) |
+
+**Returns:** `Promise<ApiResponse<DocAuthInfo>>`
+
+Response `data` contains document fields including `first_name`, `last_name`, `birth_date`, `document_number`, `document_type`, `country_code`, `portrait_photo` (base64), and `face_image_base64` (cropped face, base64).
+
+---
+
+### Response Headers
+
+Useful headers returned by the API:
+
+| Header | Description |
+|--------|-------------|
+| `x-request-id` | Unique request identifier for debugging |
+| `x-auto-enroll` | Set to `"true"` when `processVideo` triggers auto-enrollment |
+| `x-removed-services` | Set to `"true"` when consent-dependent services were removed from video processing |
+
+```typescript
+const response = await sdk.processVideo(videoFile, '12345678', 'Jane Doe');
+
+console.log(response.headers['x-request-id']);
+console.log(response.headers['x-auto-enroll']);     // "true" if auto-enrolled
+console.log(response.headers['x-removed-services']); // "true" if services were skipped
+```
+
+## Error Handling
+
+All SDK methods throw errors on validation failures or unsuccessful HTTP responses. Always wrap calls in `try/catch`:
+
+```typescript
+try {
+  const response = await sdk.processVideo(videoFile, '12345678', 'Jane Doe');
+  // Handle success
+} catch (error) {
+  console.error(error.message);
+  // Example: "Error 400: 'phrase' form value is required"
+}
+```
+
+Common error scenarios:
+
+| Scenario | When it happens |
+|----------|-----------------|
+| Missing API key | `new BiometrySDK('')` |
+| Missing required parameter | e.g. calling `enrollFace` without a file or name |
+| No face detected | Face enrollment with an image that has no detectable face |
+| Multiple faces detected | Face enrollment with an image containing more than one face |
+| Liveness check failed | Video processing detects a spoofing attempt |
+| No speech detected | Voice enrollment with an audio file containing no speech |
+| Network failure | Server unreachable or request timeout |
+| Consent not given | Calling `enrollFace` or `enrollVoice` without storage consent |
+| Prefilled video without session | Calling `matchFaces` with `usePrefilledVideo: true` but no `sessionId` |
+| No video found for reuse | Using `usePrefilledVideo` in a session that has no prior `processVideo` call |
+| Invalid document format | Calling `checkDocAuth` with a non-JPG/JPEG/PNG file |
+| File size exceeded | Uploading a file larger than 50MB |
+
+## Security & Privacy
+
+1. **Protect your API key** — use environment variables or a server-side proxy. Never commit keys to source control.
+2. **Obtain explicit consent** — always collect authorization and storage consent through your UI before calling biometric APIs.
+3. **Data minimization** — only collect and store data that is necessary for your use case.
+4. **Regulatory compliance** — check local regulations (GDPR, CCPA, etc.) regarding the collection and processing of biometric data.
+
+## Examples
+
+Working examples are available in the [`examples/`](./examples) directory:
+
+- **[React example](./examples/react-example)** — full React app demonstrating SDK initialization, consent, face enrollment, and video processing
+- **[HTML example](./examples/html-example)** — vanilla JavaScript integration without any framework
 
 ## License
 
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Support
 
-## More Information
-For more detailed information on Biometry's API endpoints, parameters, and responses, visit the official [Biometry API Documentation](https://developer.biometrysolutions.com/overview/). If you have questions or need help, please reach out to our support team or create a GitHub issue.  
+- [Biometry API Documentation](https://developer.biometrysolutions.com/overview/)
+- [GitHub Issues](https://github.com/nicoogamer/biometry-web-sdk/issues)
+- Contact our support team at [support@biometrysolutions.com](mailto:support@biometrysolutions.com)

package/dist/sdk/index.d.ts

@@ -1,5 +1,5 @@
 import { ApiResponse } from "../types/internal";
-import { DocAuthInfo } from "../types/biometry/doc-auth";
+import { DocAuthResponse } from "../types/biometry/doc-auth";
 import { ConsentResponse } from "../types/biometry/consent";
 import { FaceEnrollmentResponse, VoiceEnrollmentResponse } from "../types/biometry/enrollment";
 import { FaceMatchResponse } from "../types/biometry/face-match";
@@ -95,13 +95,13 @@ export declare class BiometrySDK {
      * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.
      * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.
      *                                      This can include properties like operating system, browser, etc.
-     * @returns {Promise<ApiResponse<DocAuthInfo>>} - A promise resolving to the document authentication information.
+     * @returns {Promise<ApiResponse<DocAuthResponse>>} - A promise resolving to the document authentication response.
      */
     checkDocAuth(document: File, userFullName: string, props?: {
         sessionId?: string;
         deviceInfo?: object;
         inHouseCheck?: boolean;
-    }): Promise<ApiResponse<DocAuthInfo>>;
+    }): Promise<ApiResponse<DocAuthResponse>>;
     /**
      * Matches a user's face from video against a reference image.
      *

package/dist/sdk.js

@@ -185,7 +185,7 @@ class BiometrySDK {
      * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.
      * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.
      *                                      This can include properties like operating system, browser, etc.
-     * @returns {Promise<ApiResponse<DocAuthInfo>>} - A promise resolving to the document authentication information.
+     * @returns {Promise<ApiResponse<DocAuthResponse>>} - A promise resolving to the document authentication response.
      */
     async checkDocAuth(document, userFullName, props) {
         if (!document)

package/dist/sdk.js.map

@@ -1 +1 @@
-{"version":3,"file":"sdk.js","sources":["../src/sdk/index.ts"],"sourcesContent":["import { ApiResponse } from \"../types/internal\";\nimport { DocAuthInfo } from \"../types/biometry/doc-auth\";\nimport { ConsentResponse } from \"../types/biometry/consent\";\nimport { FaceEnrollmentResponse, VoiceEnrollmentResponse } from \"../types/biometry/enrollment\";\nimport { FaceMatchResponse } from \"../types/biometry/face-match\";\nimport { ProcessVideoResponse } from \"../types/biometry/process-video\";\nimport { SessionResponse } from \"../types/biometry/session\";\n\nexport class BiometrySDK {\n  private apiKey: string;\n  private static readonly BASE_URL: string = 'https://api.biometrysolutions.com'; //'https://dev-console.biometrysolutions.com';\n\n  constructor(apiKey: string) {\n    if (!apiKey) {\n      throw new Error('API Key is required to initialize the SDK.');\n    }\n\n    this.apiKey = apiKey;\n  }\n\n  private async request<T>(path: string, method: string, body?: any, headers?: Record<string, string>):\n    Promise<ApiResponse<T>> {\n    const defaultHeaders: HeadersInit = {\n      Authorization: `Bearer ${this.apiKey}`,\n    };\n\n    const requestHeaders = { ...defaultHeaders, ...headers };\n\n    if (body && !(body instanceof FormData)) {\n      requestHeaders['Content-Type'] = 'application/json';\n      body = JSON.stringify(body);\n    }\n    const response = await fetch(`${BiometrySDK.BASE_URL}${path}`, {\n      method,\n      headers: requestHeaders,\n      body,\n    });\n\n    if (!response.ok) {\n      const errorData = await response.json().catch(() => ({}));\n      const errorMessage = errorData?.error || errorData?.message || 'Unknown error occurred';\n\n      throw new Error(`Error ${response.status}: ${errorMessage}`);\n    }\n\n    // 🔹 Extract ALL response headers\n    const responseHeaders: Record<string, string> = {};\n    response.headers.forEach((value, key) => {\n      responseHeaders[key] = value;\n    });\n\n    const responseBody = await response.json();\n\n    return {\n      body: responseBody as T,\n      headers: responseHeaders\n    };\n  }\n\n  /**\n   * Starts a new Session for a user.\n   * \n   * @returns {Promise<ApiResponse<SessionResponse>>} A promise resolving to the session ID.\n   * @throws {Error} - If the request fails.\n   */\n  async startSession(): Promise<ApiResponse<SessionResponse>> {\n    return await this.request<SessionResponse>(\n      '/api-gateway/sessions/start',\n      'POST'\n    );\n  }\n\n  /**\n   * Submits Authorization consent for a user.\n   * Authorization Consent is required to use the services like Face and Voice recognition.\n   * \n   * @param {boolean} isConsentGiven - Indicates whether the user has given consent.\n   * @param {string} userFullName - The full name of the user giving consent.\n   * @param {Object} [props] - Optional properties for the consent request.\n   * @param {string} [props.sessionId] - Session ID to link this consent with a specific session group.\n   * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.\n   *                                      This can include properties like operating system, browser, etc.\n   * @returns {Promise<ApiResponse<ConsentResponse>>} A promise resolving to the consent response.\n   * @throws {Error} - If the user's full name is not provided or if the request fails.\n   */\n  async giveAuthorizationConsent(\n    isConsentGiven: boolean,\n    userFullName: string,\n    props?: {\n      sessionId?: string,\n      deviceInfo?: object,\n    }\n  ): Promise<ApiResponse<ConsentResponse>> {\n    if (!userFullName) {\n      throw new Error('User Full Name is required to give consent.');\n    }\n\n    const body = {\n      is_consent_given: isConsentGiven,\n      user_fullname: userFullName,\n    };\n\n    const headers: Record<string, string> = {};\n\n    if (props?.sessionId) {\n      headers['X-Session-ID'] = props.sessionId;\n    }\n\n    if (props?.deviceInfo) {\n      headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);\n    }\n\n    return await this.request<ConsentResponse>(\n      '/api-consent/consent',\n      'POST',\n      body,\n      headers\n    );\n  }\n\n  /**\n   * Submits Storage consent for a user.\n   * Storage consent is granted by users, allowing us to store their biometric data for future verification.\n   * \n   * @param {boolean} isStorageConsentGiven - Indicates whether the user has given storage consent.\n   * @param {string} userFullName - The full name of the user giving storage consent.\n   * @param {Object} [props] - Optional properties for the consent request.\n   * @param {string} [props.sessionId] - Session ID to link this consent with a specific session group.\n   * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.\n   *                                      This can include properties like operating system, browser, etc.\n   * @returns {Promise<ApiResponse<ConsentResponse>>} A promise resolving to the consent response.\n   * @throws {Error} - If the user's full name is not provided or if the request fails.\n   */\n  async giveStorageConsent(\n    isStorageConsentGiven: boolean,\n    userFullName: string,\n    props?: {\n      sessionId?: string,\n      deviceInfo?: object,\n    }\n  ): Promise<ApiResponse<ConsentResponse>> {\n    if (!userFullName) {\n      throw new Error('User Full Name is required to give storage consent.');\n    }\n\n    const body = {\n      is_consent_given: isStorageConsentGiven,\n      user_fullname: userFullName,\n    };\n\n    const headers: Record<string, string> = {};\n\n    if (props?.sessionId) {\n      headers['X-Session-ID'] = props.sessionId;\n    }\n\n    if (props?.deviceInfo) {\n      headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);\n    }\n\n    return await this.request<ConsentResponse>(\n      '/api-consent/strg-consent',\n      'POST',\n      body,\n      headers\n    );\n  }\n\n  /**\n   * Enrolls a user's voice for biometric authentication.\n   * \n   * @param {File} audio - The audio file containing the user's voice.\n   * @param {string} userFullName - The full name of the user being enrolled.\n   * @param {string} uniqueId - A unique identifier for the enrolling process.\n   * @param {string} phrase - The phrase spoken in the audio file.\n   * @param {Object} [props] - Optional properties for the enrollment request.\n   * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.\n   * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.\n   *                                      This can include properties like operating system, browser, etc.\n   * @returns {Promise<ApiResponse<VoiceEnrollmentResponse>>} - A promise resolving to the voice enrolling response.\n   * @throws {Error} - If required parameters are missing or the request fails.\n   */\n  async enrollVoice(\n    audio: File,\n    userFullName: string,\n    uniqueId: string,\n    phrase: string,\n    props?: {\n      sessionId?: string,\n      deviceInfo?: object,\n    }\n  ): Promise<ApiResponse<VoiceEnrollmentResponse>> {\n    if (!userFullName) throw new Error('User fullname is required.');\n    if (!uniqueId) throw new Error('Unique ID is required.');\n    if (!phrase) throw new Error('Phrase is required.');\n    if (!audio) throw new Error('Audio file is required.');\n\n    const formData = new FormData();\n    formData.append('unique_id', uniqueId);\n    formData.append('phrase', phrase);\n    formData.append('voice', audio);\n\n    const headers: Record<string, string> = {\n      'X-User-Fullname': userFullName,\n    };\n\n    if (props?.sessionId) {\n      headers['X-Session-ID'] = props.sessionId;\n    }\n\n    if (props?.deviceInfo) {\n      headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);\n    }\n\n    return await this.request<VoiceEnrollmentResponse>(\n      '/api-gateway/enroll/voice',\n      'POST',\n      formData,\n      headers\n    );\n  }\n\n  /**\n   * Enrolls a user's face for biometric authentication.\n   * \n   * @param {File} face - Image file that contains user's face.\n   * @param {string} userFullName - The full name of the user being enrolled.\n   * @param {string} isDocument - Indicates whether the image is a document.\n   * @param {Object} [props] - Optional properties for the enrollment request.\n   * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.\n   * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.\n   *                                      This can include properties like operating system, browser, etc.\n   * @returns {Promise<ApiResponse<FaceEnrollmentResponse>>} - A promise resolving to the voice enrolling response.\n   * @throws {Error} - If required parameters are missing or the request fails.\n   */\n  async enrollFace(face: File, userFullName: string, isDocument?: boolean, props?: {\n    sessionId?: string,\n    deviceInfo?: object,\n  }):\n    Promise<ApiResponse<FaceEnrollmentResponse>> {\n    if (!userFullName) throw new Error('User fullname is required.');\n    if (!face) throw new Error('Face image is required.');\n\n    const formData = new FormData();\n    formData.append('face', face);\n    if (isDocument) {\n      formData.append('is_document', 'true');\n    }\n\n    const headers: Record<string, string> = {\n      'X-User-Fullname': userFullName,\n    };\n\n    if (props?.sessionId) {\n      headers['X-Session-ID'] = props.sessionId;\n    }\n\n    if (props?.deviceInfo) {\n      headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);\n    }\n\n    return await this.request<FaceEnrollmentResponse>(\n      '/api-gateway/enroll/face',\n      'POST',\n      formData,\n      headers\n    );\n  }\n\n  /**\n   * Check the validity of a documents.\n   * \n   * @param {File} document - Document image file.\n   * @param {string} userFullName - The full name of the user being checked.\n   * @param {Object} [props] - Optional properties for the enrollment request.\n   * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.\n   * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.\n   *                                      This can include properties like operating system, browser, etc.\n   * @returns {Promise<ApiResponse<DocAuthInfo>>} - A promise resolving to the document authentication information.\n   */\n  async checkDocAuth(\n    document: File,\n    userFullName: string,\n    props?: {\n      sessionId?: string,\n      deviceInfo?: object,\n      inHouseCheck?: boolean,\n    }\n  ): Promise<ApiResponse<DocAuthInfo>> {\n    if (!document) throw new Error('Document image is required.');\n    if (!userFullName) throw new Error('User fullname is required.');\n\n    const formData = new FormData();\n    formData.append('document', document);\n\n    const headers: Record<string, string> = {\n      'X-User-Fullname': userFullName,\n    };\n\n    if (props?.sessionId) {\n      headers['X-Session-ID'] = props.sessionId;\n    }\n\n    if (props?.deviceInfo) {\n      headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);\n    }\n\n    if (props?.inHouseCheck) {\n      headers['X-Inhouse-Docauth'] = \"true\";\n    }\n\n    return await this.request<DocAuthInfo>(\n      '/api-gateway/docauth/check',\n      'POST',\n      formData,\n      headers\n    );\n  }\n\n  /**\n   * Matches a user's face from video against a reference image.\n   * \n   * @param {File} image - Reference image file that contains user's face.\n   * @param {string} video - Video file that contains user's face.\n   * @param {string} userFullName - Pass the full name of end-user to process Voice and Face recognition services.\n   * @param {string} processVideoRequestId - ID from the response header of /process-video endpoint.\n   * @param {boolean} usePrefilledVideo - Pass true to use the video from the process-video endpoint.\n   * @param {Object} [props] - Optional properties for the enrollment request.\n   * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.\n   * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.\n   *                                      This can include properties like operating system, browser, etc.\n   * @returns {Promise<FaceMatchResponse>} - A promise resolving to the voice enrolling response.\n   * @throws {Error} - If required parameters are missing or the request fails.\n   */\n  async matchFaces(\n    image: File,\n    video?: File,\n    userFullName?: string,\n    usePrefilledVideo?: boolean,\n    props?: {\n      sessionId?: string,\n      deviceInfo?: object,\n    }\n  ): Promise<ApiResponse<FaceMatchResponse>> {\n    if (!image) throw new Error('Face image is required.');\n    if ((!usePrefilledVideo) && !video) throw new Error('Video is required.');\n    if (usePrefilledVideo && !props?.sessionId) throw new Error('Session ID is required to use a video from the process-video endpoint.');\n\n    const formData = new FormData();\n    if (video) {\n      formData.append('video', video);\n    }\n    formData.append('image', image);\n\n    const headers: Record<string, string> = {};\n\n    if (userFullName) {\n      headers['X-User-Fullname'] = userFullName;\n    }\n\n    if (usePrefilledVideo) {\n      headers['X-Use-Prefilled-Video'] = 'true';\n    }\n\n    if (props?.sessionId) {\n      headers['X-Session-ID'] = props.sessionId;\n    }\n\n    if (props?.deviceInfo) {\n      headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);\n    }\n\n    return await this.request<FaceMatchResponse>(\n      '/api-gateway/match-faces',\n      'POST',\n      formData,\n      headers\n    );\n  }\n\n  /**\n   * Process the video through Biometry services to check liveness and authorize user\n   * \n   * @param {File} video - Video file that you want to process.\n   * @param {string} phrase - Set of numbers that user needs to say out loud in the video.\n   * @param {string} userFullName - Pass the full name of end-user to process Voice and Face recognition services.\n   * @param {Object} [props] - Optional properties for the enrollment request.\n   * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.\n   * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.\n   *                                      This can include properties like operating system, browser, etc.\n   * @returns {Promise<ApiResponse<ProcessVideoResponse>>} - A promise resolving to the process video response.\n   */\n  async processVideo(\n    video: File,\n    phrase: string,\n    userFullName?: string,\n    props?: {\n      sessionId?: string,\n      deviceInfo?: object,\n    }\n  ): Promise<ApiResponse<ProcessVideoResponse>> {\n    if (!video) throw new Error('Video is required.');\n    if (!phrase) throw new Error('Phrase is required.');\n\n    const formData = new FormData();\n    formData.append('phrase', phrase);\n    formData.append('video', video);\n\n    const headers: Record<string, string> = {};\n\n    if (userFullName) {\n      headers['X-User-Fullname'] = userFullName;\n    }\n\n    if (props?.sessionId) {\n      headers['X-Session-ID'] = props.sessionId;\n    }\n\n    if (props?.deviceInfo) {\n      headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);\n    }\n\n    return await this.request<ProcessVideoResponse>(\n      '/api-gateway/process-video',\n      'POST',\n      formData,\n      headers\n    );\n  }\n}"],"names":[],"mappings":"MAQa,WAAW,CAAA;AAItB,IAAA,WAAA,CAAY,MAAc,EAAA;QACxB,IAAI,CAAC,MAAM,EAAE;AACX,YAAA,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC;QAC/D;AAEA,QAAA,IAAI,CAAC,MAAM,GAAG,MAAM;IACtB;IAEQ,MAAM,OAAO,CAAI,IAAY,EAAE,MAAc,EAAE,IAAU,EAAE,OAAgC,EAAA;AAEjG,QAAA,MAAM,cAAc,GAAgB;AAClC,YAAA,aAAa,EAAE,CAAA,OAAA,EAAU,IAAI,CAAC,MAAM,CAAA,CAAE;SACvC;QAED,MAAM,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,EAAE;QAExD,IAAI,IAAI,IAAI,EAAE,IAAI,YAAY,QAAQ,CAAC,EAAE;AACvC,YAAA,cAAc,CAAC,cAAc,CAAC,GAAG,kBAAkB;AACnD,YAAA,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;QAC7B;AACA,QAAA,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,CAAA,EAAG,WAAW,CAAC,QAAQ,CAAA,EAAG,IAAI,CAAA,CAAE,EAAE;YAC7D,MAAM;AACN,YAAA,OAAO,EAAE,cAAc;YACvB,IAAI;AACL,SAAA,CAAC;AAEF,QAAA,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;AAChB,YAAA,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACzD,MAAM,YAAY,GAAG,SAAS,EAAE,KAAK,IAAI,SAAS,EAAE,OAAO,IAAI,wBAAwB;YAEvF,MAAM,IAAI,KAAK,CAAC,CAAA,MAAA,EAAS,QAAQ,CAAC,MAAM,CAAA,EAAA,EAAK,YAAY,CAAA,CAAE,CAAC;QAC9D;;QAGA,MAAM,eAAe,GAA2B,EAAE;QAClD,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,KAAI;AACtC,YAAA,eAAe,CAAC,GAAG,CAAC,GAAG,KAAK;AAC9B,QAAA,CAAC,CAAC;AAEF,QAAA,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE;QAE1C,OAAO;AACL,YAAA,IAAI,EAAE,YAAiB;AACvB,YAAA,OAAO,EAAE;SACV;IACH;AAEA;;;;;AAKG;AACH,IAAA,MAAM,YAAY,GAAA;QAChB,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,6BAA6B,EAC7B,MAAM,CACP;IACH;AAEA;;;;;;;;;;;;AAYG;AACH,IAAA,MAAM,wBAAwB,CAC5B,cAAuB,EACvB,YAAoB,EACpB,KAGC,EAAA;QAED,IAAI,CAAC,YAAY,EAAE;AACjB,YAAA,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC;QAChE;AAEA,QAAA,MAAM,IAAI,GAAG;AACX,YAAA,gBAAgB,EAAE,cAAc;AAChC,YAAA,aAAa,EAAE,YAAY;SAC5B;QAED,MAAM,OAAO,GAA2B,EAAE;AAE1C,QAAA,IAAI,KAAK,EAAE,SAAS,EAAE;AACpB,YAAA,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,SAAS;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,UAAU,EAAE;AACrB,YAAA,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7D;AAEA,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,sBAAsB,EACtB,MAAM,EACN,IAAI,EACJ,OAAO,CACR;IACH;AAEA;;;;;;;;;;;;AAYG;AACH,IAAA,MAAM,kBAAkB,CACtB,qBAA8B,EAC9B,YAAoB,EACpB,KAGC,EAAA;QAED,IAAI,CAAC,YAAY,EAAE;AACjB,YAAA,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC;QACxE;AAEA,QAAA,MAAM,IAAI,GAAG;AACX,YAAA,gBAAgB,EAAE,qBAAqB;AACvC,YAAA,aAAa,EAAE,YAAY;SAC5B;QAED,MAAM,OAAO,GAA2B,EAAE;AAE1C,QAAA,IAAI,KAAK,EAAE,SAAS,EAAE;AACpB,YAAA,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,SAAS;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,UAAU,EAAE;AACrB,YAAA,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7D;AAEA,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,2BAA2B,EAC3B,MAAM,EACN,IAAI,EACJ,OAAO,CACR;IACH;AAEA;;;;;;;;;;;;;AAaG;IACH,MAAM,WAAW,CACf,KAAW,EACX,YAAoB,EACpB,QAAgB,EAChB,MAAc,EACd,KAGC,EAAA;AAED,QAAA,IAAI,CAAC,YAAY;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC;AAChE,QAAA,IAAI,CAAC,QAAQ;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC;AACxD,QAAA,IAAI,CAAC,MAAM;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC;AACnD,QAAA,IAAI,CAAC,KAAK;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC;AAEtD,QAAA,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE;AAC/B,QAAA,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC;AACtC,QAAA,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;AACjC,QAAA,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC;AAE/B,QAAA,MAAM,OAAO,GAA2B;AACtC,YAAA,iBAAiB,EAAE,YAAY;SAChC;AAED,QAAA,IAAI,KAAK,EAAE,SAAS,EAAE;AACpB,YAAA,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,SAAS;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,UAAU,EAAE;AACrB,YAAA,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7D;AAEA,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,2BAA2B,EAC3B,MAAM,EACN,QAAQ,EACR,OAAO,CACR;IACH;AAEA;;;;;;;;;;;;AAYG;IACH,MAAM,UAAU,CAAC,IAAU,EAAE,YAAoB,EAAE,UAAoB,EAAE,KAGxE,EAAA;AAEC,QAAA,IAAI,CAAC,YAAY;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC;AAChE,QAAA,IAAI,CAAC,IAAI;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC;AAErD,QAAA,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE;AAC/B,QAAA,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC;QAC7B,IAAI,UAAU,EAAE;AACd,YAAA,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC;QACxC;AAEA,QAAA,MAAM,OAAO,GAA2B;AACtC,YAAA,iBAAiB,EAAE,YAAY;SAChC;AAED,QAAA,IAAI,KAAK,EAAE,SAAS,EAAE;AACpB,YAAA,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,SAAS;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,UAAU,EAAE;AACrB,YAAA,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7D;AAEA,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,0BAA0B,EAC1B,MAAM,EACN,QAAQ,EACR,OAAO,CACR;IACH;AAEA;;;;;;;;;;AAUG;AACH,IAAA,MAAM,YAAY,CAChB,QAAc,EACd,YAAoB,EACpB,KAIC,EAAA;AAED,QAAA,IAAI,CAAC,QAAQ;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC;AAC7D,QAAA,IAAI,CAAC,YAAY;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC;AAEhE,QAAA,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE;AAC/B,QAAA,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC;AAErC,QAAA,MAAM,OAAO,GAA2B;AACtC,YAAA,iBAAiB,EAAE,YAAY;SAChC;AAED,QAAA,IAAI,KAAK,EAAE,SAAS,EAAE;AACpB,YAAA,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,SAAS;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,UAAU,EAAE;AACrB,YAAA,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7D;AAEA,QAAA,IAAI,KAAK,EAAE,YAAY,EAAE;AACvB,YAAA,OAAO,CAAC,mBAAmB,CAAC,GAAG,MAAM;QACvC;AAEA,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,4BAA4B,EAC5B,MAAM,EACN,QAAQ,EACR,OAAO,CACR;IACH;AAEA;;;;;;;;;;;;;;AAcG;IACH,MAAM,UAAU,CACd,KAAW,EACX,KAAY,EACZ,YAAqB,EACrB,iBAA2B,EAC3B,KAGC,EAAA;AAED,QAAA,IAAI,CAAC,KAAK;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC;AACtD,QAAA,IAAI,CAAC,CAAC,iBAAiB,KAAK,CAAC,KAAK;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC;AACzE,QAAA,IAAI,iBAAiB,IAAI,CAAC,KAAK,EAAE,SAAS;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC;AAErI,QAAA,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE;QAC/B,IAAI,KAAK,EAAE;AACT,YAAA,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC;QACjC;AACA,QAAA,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC;QAE/B,MAAM,OAAO,GAA2B,EAAE;QAE1C,IAAI,YAAY,EAAE;AAChB,YAAA,OAAO,CAAC,iBAAiB,CAAC,GAAG,YAAY;QAC3C;QAEA,IAAI,iBAAiB,EAAE;AACrB,YAAA,OAAO,CAAC,uBAAuB,CAAC,GAAG,MAAM;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,SAAS,EAAE;AACpB,YAAA,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,SAAS;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,UAAU,EAAE;AACrB,YAAA,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7D;AAEA,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,0BAA0B,EAC1B,MAAM,EACN,QAAQ,EACR,OAAO,CACR;IACH;AAEA;;;;;;;;;;;AAWG;IACH,MAAM,YAAY,CAChB,KAAW,EACX,MAAc,EACd,YAAqB,EACrB,KAGC,EAAA;AAED,QAAA,IAAI,CAAC,KAAK;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC;AACjD,QAAA,IAAI,CAAC,MAAM;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC;AAEnD,QAAA,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE;AAC/B,QAAA,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;AACjC,QAAA,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC;QAE/B,MAAM,OAAO,GAA2B,EAAE;QAE1C,IAAI,YAAY,EAAE;AAChB,YAAA,OAAO,CAAC,iBAAiB,CAAC,GAAG,YAAY;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,SAAS,EAAE;AACpB,YAAA,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,SAAS;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,UAAU,EAAE;AACrB,YAAA,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7D;AAEA,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,4BAA4B,EAC5B,MAAM,EACN,QAAQ,EACR,OAAO,CACR;IACH;;AAlawB,WAAA,CAAA,QAAQ,GAAW,mCAAmC,CAAC;;;;"}
+{"version":3,"file":"sdk.js","sources":["../src/sdk/index.ts"],"sourcesContent":["import { ApiResponse } from \"../types/internal\";\nimport { DocAuthResponse } from \"../types/biometry/doc-auth\";\nimport { ConsentResponse } from \"../types/biometry/consent\";\nimport { FaceEnrollmentResponse, VoiceEnrollmentResponse } from \"../types/biometry/enrollment\";\nimport { FaceMatchResponse } from \"../types/biometry/face-match\";\nimport { ProcessVideoResponse } from \"../types/biometry/process-video\";\nimport { SessionResponse } from \"../types/biometry/session\";\n\nexport class BiometrySDK {\n  private apiKey: string;\n  private static readonly BASE_URL: string = 'https://api.biometrysolutions.com'; //'https://dev-console.biometrysolutions.com';\n\n  constructor(apiKey: string) {\n    if (!apiKey) {\n      throw new Error('API Key is required to initialize the SDK.');\n    }\n\n    this.apiKey = apiKey;\n  }\n\n  private async request<T>(path: string, method: string, body?: any, headers?: Record<string, string>):\n    Promise<ApiResponse<T>> {\n    const defaultHeaders: HeadersInit = {\n      Authorization: `Bearer ${this.apiKey}`,\n    };\n\n    const requestHeaders = { ...defaultHeaders, ...headers };\n\n    if (body && !(body instanceof FormData)) {\n      requestHeaders['Content-Type'] = 'application/json';\n      body = JSON.stringify(body);\n    }\n    const response = await fetch(`${BiometrySDK.BASE_URL}${path}`, {\n      method,\n      headers: requestHeaders,\n      body,\n    });\n\n    if (!response.ok) {\n      const errorData = await response.json().catch(() => ({}));\n      const errorMessage = errorData?.error || errorData?.message || 'Unknown error occurred';\n\n      throw new Error(`Error ${response.status}: ${errorMessage}`);\n    }\n\n    // 🔹 Extract ALL response headers\n    const responseHeaders: Record<string, string> = {};\n    response.headers.forEach((value, key) => {\n      responseHeaders[key] = value;\n    });\n\n    const responseBody = await response.json();\n\n    return {\n      body: responseBody as T,\n      headers: responseHeaders\n    };\n  }\n\n  /**\n   * Starts a new Session for a user.\n   * \n   * @returns {Promise<ApiResponse<SessionResponse>>} A promise resolving to the session ID.\n   * @throws {Error} - If the request fails.\n   */\n  async startSession(): Promise<ApiResponse<SessionResponse>> {\n    return await this.request<SessionResponse>(\n      '/api-gateway/sessions/start',\n      'POST'\n    );\n  }\n\n  /**\n   * Submits Authorization consent for a user.\n   * Authorization Consent is required to use the services like Face and Voice recognition.\n   * \n   * @param {boolean} isConsentGiven - Indicates whether the user has given consent.\n   * @param {string} userFullName - The full name of the user giving consent.\n   * @param {Object} [props] - Optional properties for the consent request.\n   * @param {string} [props.sessionId] - Session ID to link this consent with a specific session group.\n   * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.\n   *                                      This can include properties like operating system, browser, etc.\n   * @returns {Promise<ApiResponse<ConsentResponse>>} A promise resolving to the consent response.\n   * @throws {Error} - If the user's full name is not provided or if the request fails.\n   */\n  async giveAuthorizationConsent(\n    isConsentGiven: boolean,\n    userFullName: string,\n    props?: {\n      sessionId?: string,\n      deviceInfo?: object,\n    }\n  ): Promise<ApiResponse<ConsentResponse>> {\n    if (!userFullName) {\n      throw new Error('User Full Name is required to give consent.');\n    }\n\n    const body = {\n      is_consent_given: isConsentGiven,\n      user_fullname: userFullName,\n    };\n\n    const headers: Record<string, string> = {};\n\n    if (props?.sessionId) {\n      headers['X-Session-ID'] = props.sessionId;\n    }\n\n    if (props?.deviceInfo) {\n      headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);\n    }\n\n    return await this.request<ConsentResponse>(\n      '/api-consent/consent',\n      'POST',\n      body,\n      headers\n    );\n  }\n\n  /**\n   * Submits Storage consent for a user.\n   * Storage consent is granted by users, allowing us to store their biometric data for future verification.\n   * \n   * @param {boolean} isStorageConsentGiven - Indicates whether the user has given storage consent.\n   * @param {string} userFullName - The full name of the user giving storage consent.\n   * @param {Object} [props] - Optional properties for the consent request.\n   * @param {string} [props.sessionId] - Session ID to link this consent with a specific session group.\n   * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.\n   *                                      This can include properties like operating system, browser, etc.\n   * @returns {Promise<ApiResponse<ConsentResponse>>} A promise resolving to the consent response.\n   * @throws {Error} - If the user's full name is not provided or if the request fails.\n   */\n  async giveStorageConsent(\n    isStorageConsentGiven: boolean,\n    userFullName: string,\n    props?: {\n      sessionId?: string,\n      deviceInfo?: object,\n    }\n  ): Promise<ApiResponse<ConsentResponse>> {\n    if (!userFullName) {\n      throw new Error('User Full Name is required to give storage consent.');\n    }\n\n    const body = {\n      is_consent_given: isStorageConsentGiven,\n      user_fullname: userFullName,\n    };\n\n    const headers: Record<string, string> = {};\n\n    if (props?.sessionId) {\n      headers['X-Session-ID'] = props.sessionId;\n    }\n\n    if (props?.deviceInfo) {\n      headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);\n    }\n\n    return await this.request<ConsentResponse>(\n      '/api-consent/strg-consent',\n      'POST',\n      body,\n      headers\n    );\n  }\n\n  /**\n   * Enrolls a user's voice for biometric authentication.\n   * \n   * @param {File} audio - The audio file containing the user's voice.\n   * @param {string} userFullName - The full name of the user being enrolled.\n   * @param {string} uniqueId - A unique identifier for the enrolling process.\n   * @param {string} phrase - The phrase spoken in the audio file.\n   * @param {Object} [props] - Optional properties for the enrollment request.\n   * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.\n   * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.\n   *                                      This can include properties like operating system, browser, etc.\n   * @returns {Promise<ApiResponse<VoiceEnrollmentResponse>>} - A promise resolving to the voice enrolling response.\n   * @throws {Error} - If required parameters are missing or the request fails.\n   */\n  async enrollVoice(\n    audio: File,\n    userFullName: string,\n    uniqueId: string,\n    phrase: string,\n    props?: {\n      sessionId?: string,\n      deviceInfo?: object,\n    }\n  ): Promise<ApiResponse<VoiceEnrollmentResponse>> {\n    if (!userFullName) throw new Error('User fullname is required.');\n    if (!uniqueId) throw new Error('Unique ID is required.');\n    if (!phrase) throw new Error('Phrase is required.');\n    if (!audio) throw new Error('Audio file is required.');\n\n    const formData = new FormData();\n    formData.append('unique_id', uniqueId);\n    formData.append('phrase', phrase);\n    formData.append('voice', audio);\n\n    const headers: Record<string, string> = {\n      'X-User-Fullname': userFullName,\n    };\n\n    if (props?.sessionId) {\n      headers['X-Session-ID'] = props.sessionId;\n    }\n\n    if (props?.deviceInfo) {\n      headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);\n    }\n\n    return await this.request<VoiceEnrollmentResponse>(\n      '/api-gateway/enroll/voice',\n      'POST',\n      formData,\n      headers\n    );\n  }\n\n  /**\n   * Enrolls a user's face for biometric authentication.\n   * \n   * @param {File} face - Image file that contains user's face.\n   * @param {string} userFullName - The full name of the user being enrolled.\n   * @param {string} isDocument - Indicates whether the image is a document.\n   * @param {Object} [props] - Optional properties for the enrollment request.\n   * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.\n   * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.\n   *                                      This can include properties like operating system, browser, etc.\n   * @returns {Promise<ApiResponse<FaceEnrollmentResponse>>} - A promise resolving to the voice enrolling response.\n   * @throws {Error} - If required parameters are missing or the request fails.\n   */\n  async enrollFace(face: File, userFullName: string, isDocument?: boolean, props?: {\n    sessionId?: string,\n    deviceInfo?: object,\n  }):\n    Promise<ApiResponse<FaceEnrollmentResponse>> {\n    if (!userFullName) throw new Error('User fullname is required.');\n    if (!face) throw new Error('Face image is required.');\n\n    const formData = new FormData();\n    formData.append('face', face);\n    if (isDocument) {\n      formData.append('is_document', 'true');\n    }\n\n    const headers: Record<string, string> = {\n      'X-User-Fullname': userFullName,\n    };\n\n    if (props?.sessionId) {\n      headers['X-Session-ID'] = props.sessionId;\n    }\n\n    if (props?.deviceInfo) {\n      headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);\n    }\n\n    return await this.request<FaceEnrollmentResponse>(\n      '/api-gateway/enroll/face',\n      'POST',\n      formData,\n      headers\n    );\n  }\n\n  /**\n   * Check the validity of a documents.\n   * \n   * @param {File} document - Document image file.\n   * @param {string} userFullName - The full name of the user being checked.\n   * @param {Object} [props] - Optional properties for the enrollment request.\n   * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.\n   * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.\n   *                                      This can include properties like operating system, browser, etc.\n   * @returns {Promise<ApiResponse<DocAuthResponse>>} - A promise resolving to the document authentication response.\n   */\n  async checkDocAuth(\n    document: File,\n    userFullName: string,\n    props?: {\n      sessionId?: string,\n      deviceInfo?: object,\n      inHouseCheck?: boolean,\n    }\n  ): Promise<ApiResponse<DocAuthResponse>> {\n    if (!document) throw new Error('Document image is required.');\n    if (!userFullName) throw new Error('User fullname is required.');\n\n    const formData = new FormData();\n    formData.append('document', document);\n\n    const headers: Record<string, string> = {\n      'X-User-Fullname': userFullName,\n    };\n\n    if (props?.sessionId) {\n      headers['X-Session-ID'] = props.sessionId;\n    }\n\n    if (props?.deviceInfo) {\n      headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);\n    }\n\n    if (props?.inHouseCheck) {\n      headers['X-Inhouse-Docauth'] = \"true\";\n    }\n\n    return await this.request<DocAuthResponse>(\n      '/api-gateway/docauth/check',\n      'POST',\n      formData,\n      headers\n    );\n  }\n\n  /**\n   * Matches a user's face from video against a reference image.\n   * \n   * @param {File} image - Reference image file that contains user's face.\n   * @param {string} video - Video file that contains user's face.\n   * @param {string} userFullName - Pass the full name of end-user to process Voice and Face recognition services.\n   * @param {string} processVideoRequestId - ID from the response header of /process-video endpoint.\n   * @param {boolean} usePrefilledVideo - Pass true to use the video from the process-video endpoint.\n   * @param {Object} [props] - Optional properties for the enrollment request.\n   * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.\n   * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.\n   *                                      This can include properties like operating system, browser, etc.\n   * @returns {Promise<FaceMatchResponse>} - A promise resolving to the voice enrolling response.\n   * @throws {Error} - If required parameters are missing or the request fails.\n   */\n  async matchFaces(\n    image: File,\n    video?: File,\n    userFullName?: string,\n    usePrefilledVideo?: boolean,\n    props?: {\n      sessionId?: string,\n      deviceInfo?: object,\n    }\n  ): Promise<ApiResponse<FaceMatchResponse>> {\n    if (!image) throw new Error('Face image is required.');\n    if ((!usePrefilledVideo) && !video) throw new Error('Video is required.');\n    if (usePrefilledVideo && !props?.sessionId) throw new Error('Session ID is required to use a video from the process-video endpoint.');\n\n    const formData = new FormData();\n    if (video) {\n      formData.append('video', video);\n    }\n    formData.append('image', image);\n\n    const headers: Record<string, string> = {};\n\n    if (userFullName) {\n      headers['X-User-Fullname'] = userFullName;\n    }\n\n    if (usePrefilledVideo) {\n      headers['X-Use-Prefilled-Video'] = 'true';\n    }\n\n    if (props?.sessionId) {\n      headers['X-Session-ID'] = props.sessionId;\n    }\n\n    if (props?.deviceInfo) {\n      headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);\n    }\n\n    return await this.request<FaceMatchResponse>(\n      '/api-gateway/match-faces',\n      'POST',\n      formData,\n      headers\n    );\n  }\n\n  /**\n   * Process the video through Biometry services to check liveness and authorize user\n   * \n   * @param {File} video - Video file that you want to process.\n   * @param {string} phrase - Set of numbers that user needs to say out loud in the video.\n   * @param {string} userFullName - Pass the full name of end-user to process Voice and Face recognition services.\n   * @param {Object} [props] - Optional properties for the enrollment request.\n   * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.\n   * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.\n   *                                      This can include properties like operating system, browser, etc.\n   * @returns {Promise<ApiResponse<ProcessVideoResponse>>} - A promise resolving to the process video response.\n   */\n  async processVideo(\n    video: File,\n    phrase: string,\n    userFullName?: string,\n    props?: {\n      sessionId?: string,\n      deviceInfo?: object,\n    }\n  ): Promise<ApiResponse<ProcessVideoResponse>> {\n    if (!video) throw new Error('Video is required.');\n    if (!phrase) throw new Error('Phrase is required.');\n\n    const formData = new FormData();\n    formData.append('phrase', phrase);\n    formData.append('video', video);\n\n    const headers: Record<string, string> = {};\n\n    if (userFullName) {\n      headers['X-User-Fullname'] = userFullName;\n    }\n\n    if (props?.sessionId) {\n      headers['X-Session-ID'] = props.sessionId;\n    }\n\n    if (props?.deviceInfo) {\n      headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);\n    }\n\n    return await this.request<ProcessVideoResponse>(\n      '/api-gateway/process-video',\n      'POST',\n      formData,\n      headers\n    );\n  }\n}"],"names":[],"mappings":"MAQa,WAAW,CAAA;AAItB,IAAA,WAAA,CAAY,MAAc,EAAA;QACxB,IAAI,CAAC,MAAM,EAAE;AACX,YAAA,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC;QAC/D;AAEA,QAAA,IAAI,CAAC,MAAM,GAAG,MAAM;IACtB;IAEQ,MAAM,OAAO,CAAI,IAAY,EAAE,MAAc,EAAE,IAAU,EAAE,OAAgC,EAAA;AAEjG,QAAA,MAAM,cAAc,GAAgB;AAClC,YAAA,aAAa,EAAE,CAAA,OAAA,EAAU,IAAI,CAAC,MAAM,CAAA,CAAE;SACvC;QAED,MAAM,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,EAAE;QAExD,IAAI,IAAI,IAAI,EAAE,IAAI,YAAY,QAAQ,CAAC,EAAE;AACvC,YAAA,cAAc,CAAC,cAAc,CAAC,GAAG,kBAAkB;AACnD,YAAA,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;QAC7B;AACA,QAAA,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,CAAA,EAAG,WAAW,CAAC,QAAQ,CAAA,EAAG,IAAI,CAAA,CAAE,EAAE;YAC7D,MAAM;AACN,YAAA,OAAO,EAAE,cAAc;YACvB,IAAI;AACL,SAAA,CAAC;AAEF,QAAA,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;AAChB,YAAA,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACzD,MAAM,YAAY,GAAG,SAAS,EAAE,KAAK,IAAI,SAAS,EAAE,OAAO,IAAI,wBAAwB;YAEvF,MAAM,IAAI,KAAK,CAAC,CAAA,MAAA,EAAS,QAAQ,CAAC,MAAM,CAAA,EAAA,EAAK,YAAY,CAAA,CAAE,CAAC;QAC9D;;QAGA,MAAM,eAAe,GAA2B,EAAE;QAClD,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,KAAI;AACtC,YAAA,eAAe,CAAC,GAAG,CAAC,GAAG,KAAK;AAC9B,QAAA,CAAC,CAAC;AAEF,QAAA,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE;QAE1C,OAAO;AACL,YAAA,IAAI,EAAE,YAAiB;AACvB,YAAA,OAAO,EAAE;SACV;IACH;AAEA;;;;;AAKG;AACH,IAAA,MAAM,YAAY,GAAA;QAChB,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,6BAA6B,EAC7B,MAAM,CACP;IACH;AAEA;;;;;;;;;;;;AAYG;AACH,IAAA,MAAM,wBAAwB,CAC5B,cAAuB,EACvB,YAAoB,EACpB,KAGC,EAAA;QAED,IAAI,CAAC,YAAY,EAAE;AACjB,YAAA,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC;QAChE;AAEA,QAAA,MAAM,IAAI,GAAG;AACX,YAAA,gBAAgB,EAAE,cAAc;AAChC,YAAA,aAAa,EAAE,YAAY;SAC5B;QAED,MAAM,OAAO,GAA2B,EAAE;AAE1C,QAAA,IAAI,KAAK,EAAE,SAAS,EAAE;AACpB,YAAA,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,SAAS;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,UAAU,EAAE;AACrB,YAAA,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7D;AAEA,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,sBAAsB,EACtB,MAAM,EACN,IAAI,EACJ,OAAO,CACR;IACH;AAEA;;;;;;;;;;;;AAYG;AACH,IAAA,MAAM,kBAAkB,CACtB,qBAA8B,EAC9B,YAAoB,EACpB,KAGC,EAAA;QAED,IAAI,CAAC,YAAY,EAAE;AACjB,YAAA,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC;QACxE;AAEA,QAAA,MAAM,IAAI,GAAG;AACX,YAAA,gBAAgB,EAAE,qBAAqB;AACvC,YAAA,aAAa,EAAE,YAAY;SAC5B;QAED,MAAM,OAAO,GAA2B,EAAE;AAE1C,QAAA,IAAI,KAAK,EAAE,SAAS,EAAE;AACpB,YAAA,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,SAAS;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,UAAU,EAAE;AACrB,YAAA,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7D;AAEA,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,2BAA2B,EAC3B,MAAM,EACN,IAAI,EACJ,OAAO,CACR;IACH;AAEA;;;;;;;;;;;;;AAaG;IACH,MAAM,WAAW,CACf,KAAW,EACX,YAAoB,EACpB,QAAgB,EAChB,MAAc,EACd,KAGC,EAAA;AAED,QAAA,IAAI,CAAC,YAAY;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC;AAChE,QAAA,IAAI,CAAC,QAAQ;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC;AACxD,QAAA,IAAI,CAAC,MAAM;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC;AACnD,QAAA,IAAI,CAAC,KAAK;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC;AAEtD,QAAA,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE;AAC/B,QAAA,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC;AACtC,QAAA,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;AACjC,QAAA,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC;AAE/B,QAAA,MAAM,OAAO,GAA2B;AACtC,YAAA,iBAAiB,EAAE,YAAY;SAChC;AAED,QAAA,IAAI,KAAK,EAAE,SAAS,EAAE;AACpB,YAAA,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,SAAS;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,UAAU,EAAE;AACrB,YAAA,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7D;AAEA,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,2BAA2B,EAC3B,MAAM,EACN,QAAQ,EACR,OAAO,CACR;IACH;AAEA;;;;;;;;;;;;AAYG;IACH,MAAM,UAAU,CAAC,IAAU,EAAE,YAAoB,EAAE,UAAoB,EAAE,KAGxE,EAAA;AAEC,QAAA,IAAI,CAAC,YAAY;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC;AAChE,QAAA,IAAI,CAAC,IAAI;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC;AAErD,QAAA,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE;AAC/B,QAAA,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC;QAC7B,IAAI,UAAU,EAAE;AACd,YAAA,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC;QACxC;AAEA,QAAA,MAAM,OAAO,GAA2B;AACtC,YAAA,iBAAiB,EAAE,YAAY;SAChC;AAED,QAAA,IAAI,KAAK,EAAE,SAAS,EAAE;AACpB,YAAA,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,SAAS;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,UAAU,EAAE;AACrB,YAAA,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7D;AAEA,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,0BAA0B,EAC1B,MAAM,EACN,QAAQ,EACR,OAAO,CACR;IACH;AAEA;;;;;;;;;;AAUG;AACH,IAAA,MAAM,YAAY,CAChB,QAAc,EACd,YAAoB,EACpB,KAIC,EAAA;AAED,QAAA,IAAI,CAAC,QAAQ;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC;AAC7D,QAAA,IAAI,CAAC,YAAY;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC;AAEhE,QAAA,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE;AAC/B,QAAA,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC;AAErC,QAAA,MAAM,OAAO,GAA2B;AACtC,YAAA,iBAAiB,EAAE,YAAY;SAChC;AAED,QAAA,IAAI,KAAK,EAAE,SAAS,EAAE;AACpB,YAAA,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,SAAS;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,UAAU,EAAE;AACrB,YAAA,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7D;AAEA,QAAA,IAAI,KAAK,EAAE,YAAY,EAAE;AACvB,YAAA,OAAO,CAAC,mBAAmB,CAAC,GAAG,MAAM;QACvC;AAEA,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,4BAA4B,EAC5B,MAAM,EACN,QAAQ,EACR,OAAO,CACR;IACH;AAEA;;;;;;;;;;;;;;AAcG;IACH,MAAM,UAAU,CACd,KAAW,EACX,KAAY,EACZ,YAAqB,EACrB,iBAA2B,EAC3B,KAGC,EAAA;AAED,QAAA,IAAI,CAAC,KAAK;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC;AACtD,QAAA,IAAI,CAAC,CAAC,iBAAiB,KAAK,CAAC,KAAK;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC;AACzE,QAAA,IAAI,iBAAiB,IAAI,CAAC,KAAK,EAAE,SAAS;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC;AAErI,QAAA,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE;QAC/B,IAAI,KAAK,EAAE;AACT,YAAA,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC;QACjC;AACA,QAAA,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC;QAE/B,MAAM,OAAO,GAA2B,EAAE;QAE1C,IAAI,YAAY,EAAE;AAChB,YAAA,OAAO,CAAC,iBAAiB,CAAC,GAAG,YAAY;QAC3C;QAEA,IAAI,iBAAiB,EAAE;AACrB,YAAA,OAAO,CAAC,uBAAuB,CAAC,GAAG,MAAM;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,SAAS,EAAE;AACpB,YAAA,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,SAAS;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,UAAU,EAAE;AACrB,YAAA,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7D;AAEA,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,0BAA0B,EAC1B,MAAM,EACN,QAAQ,EACR,OAAO,CACR;IACH;AAEA;;;;;;;;;;;AAWG;IACH,MAAM,YAAY,CAChB,KAAW,EACX,MAAc,EACd,YAAqB,EACrB,KAGC,EAAA;AAED,QAAA,IAAI,CAAC,KAAK;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC;AACjD,QAAA,IAAI,CAAC,MAAM;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC;AAEnD,QAAA,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE;AAC/B,QAAA,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;AACjC,QAAA,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC;QAE/B,MAAM,OAAO,GAA2B,EAAE;QAE1C,IAAI,YAAY,EAAE;AAChB,YAAA,OAAO,CAAC,iBAAiB,CAAC,GAAG,YAAY;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,SAAS,EAAE;AACpB,YAAA,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,SAAS;QAC3C;AAEA,QAAA,IAAI,KAAK,EAAE,UAAU,EAAE;AACrB,YAAA,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7D;AAEA,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,4BAA4B,EAC5B,MAAM,EACN,QAAQ,EACR,OAAO,CACR;IACH;;AAlawB,WAAA,CAAA,QAAQ,GAAW,mCAAmC,CAAC;;;;"}

package/dist/types/biometry/doc-auth.d.ts

@@ -1,6 +1,11 @@
 type Base64String = string & {
     readonly __brand: unique symbol;
 };
+export interface DocAuthResponse {
+    data: DocAuthInfo;
+    scoring_result: string;
+    message: string;
+}
 export interface DocAuthInfo {
     document_type: string;
     country_code: string;
@@ -19,7 +24,17 @@ export interface DocAuthInfo {
     issuing_state: string;
     front_document_type_id: string;
     contains_rfid: boolean;
-    current_result: string;
+    face_image_base64?: string;
+    current_result?: string;
+    mrz_validation?: MRZValidation;
     errors?: string[];
 }
+export interface MRZValidation {
+    has_mrz: boolean;
+    raw_mrz?: string;
+    check_digits_valid: boolean;
+    fields_match: boolean;
+    discrepancies?: string[];
+    validation_performed: boolean;
+}
 export {};

package/dist/types/biometry/enrollment.d.ts

@@ -1,5 +1,9 @@
 import { DocAuthInfo } from "./doc-auth";
 export interface VoiceEnrollmentResponse {
+    data: VoiceEnrollmentData;
+    message: string;
+}
+export interface VoiceEnrollmentData {
     status: "good" | "qafailed" | "enrolled" | "error";
     qa_combined: QualityResultList | null;
     qa_list: QualityResultList[];
@@ -26,7 +30,7 @@ interface RecognitionHypothesis {
 }
 export interface FaceEnrollmentResponse {
     data: {
-        enroll_result: FaceEnrollmentResult;
+        enrollment_result: FaceEnrollmentResult;
         document_auth?: DocAuthInfo;
     };
     message?: string;

package/dist/types/biometry/face-match.d.ts

@@ -1,4 +1,10 @@
 export interface FaceMatchResponse {
+    data: FaceMatchData;
+    scoring_result: Record<string, any>;
+    decision_reasons: string[];
+    message: string;
+}
+export interface FaceMatchData {
     code: number;
     result: number;
     description: string;

package/package.json

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