youverify-liveness-web 1.0.10 → 1.1.1

package/README.md

@@ -65,6 +65,7 @@ try {
 | --- | --- | --- | --- | --- | --- |
 | `presentation` | String | No | Controls how UI is displayed | `modal` | `modal`, `page` |
 | `publicKey` | String | No | Your Youverify Public Merchant Key | undefined | Valid Youverify Public Key |
+| `entityId` | String | No | Optional entity identifier to include when the liveness result is submitted | undefined | Any valid entity ID |
 | `sandboxEnvironment` | Boolean | No | Sets whether session should run in sandbox or live mode | `true` | `true`, `false` |
 | `tasks` | Array | No | Sets tasks that need to be performed for liveness to be confirmed | undefined | See [tasks](#tasks) |
 | `user` | Object | No | Sets details of user for which liveness check is being performed | undefined | See nested options below |
@@ -241,6 +242,7 @@ const initializeLivenessSDK = async () => {
     const yvLiveness = new YouverifyLiveness({
       sessionId: sessionId,
       sessionToken: sessionToken,
+      entityId: 'your_optional_entity_id',
       sandboxEnvironment: true,
       onSuccess: (data) => {
         console.log('Liveness check passed:', data);
@@ -275,6 +277,11 @@ const initializeLivenessSDK = async () => {
 initializeLivenessSDK();
 ```
 
+When the SDK submits the liveness payload to `/identity/liveness/`, it now includes:
+
+- `sdkVersion`: the SDK package version
+- `entityId`: only when you pass it during SDK initialization
+
 ### Important Notes
 
 1. **API Token Security:** Never expose your API token in frontend code. All API calls to generate `sessionId` and `sessionToken` should be made from your secure backend.
@@ -358,4 +365,4 @@ The `onSuccess` and `onFailure` callbacks (if supplied) are passed the following
 
 ## Credits
 
-This SDK is developed and maintained solely by [Youverify](https://youverify.co)
+This SDK is developed and maintained solely by [Youverify](https://youverify.co)

package/dist/index.d.ts

@@ -31,6 +31,7 @@ declare interface LivenessData {
 
 declare interface LivenessWebSdkProps {
     publicKey?: string;
+    entityId?: string;
     presentation?: Presentation;
     tasks?: Array<Task>;
     user?: User;