Vue

Follow these steps to get started with Vue.

1. Set up the workspace by running the following command:

   Shell

   npm create vue@latest livenesstest

   A folder/directory named livenesstest should appear and the folder/ directory structure should look like this:

   Directory structure

   livenesstest/
       |
       +-- node_modules/
       |
       +-- public/
       |    |
       |    \-- vite.svg
       |
       +-- src/
       |    |
       |    +-- assets\
       |    |
       |    +-- components\
       |    |
       |    +-- App.vue
       |    |
       |    +-- main.js
       |    |
       |    \-- style.css
       |
       +-- .gitignore
       |
       +-- index.html
       |
       +-- vite.config.js
       |
       +-- package-lock.json
       |
       +-- package.json
       |
       \-- README.md

2. Put the liveness folder/directory that contains the liveness engine and builders like builder.js, into the public folder/directory.

3. Add the liveness package to package.json by running this command in the livenesstest Vue project.

   Shell

   npm i file:public/liveness

   This will add @verihubs/liveness dependency in package.json.

4. Add an import to main.js file inside src folder.

   src/main.js

   import Builder from '@verihubs/liveness';

5. Add the following code to the main.js file inside src folder.

   src/index.js

   window.LivenessSDK = new Builder()
       .setCredential({
           clientId: 'YOUR_CLIENT_ID',
           secret: 'YOUR_SECRET',
       })
       .setInstruction(['look_left', 'look_right'], {
           commands: ['open_mouth'],
           seedLimit: 1,
       })
       .setProxyMiddleware({
           PassiveLiveness: {
               url: 'http://localhost:8888/liveness/face',
               headers: {
                   'App-ID': '<replace-me-with-app-id>',
                   'API-Key': '<replace-me-with-api-key>',
               },
           },
           License: {
               url: 'http://localhost:8888/license/{license_id}/check',
               headers: {
                   'App-ID': '<replace-me-with-app-id>',
                   'API-Key': '<replace-me-with-api-key>',
               },
           },
       })
       .setTimeout(60000)
       .setURL('./liveness')
       .setVirtualCameraLabel(['OBS', 'Virtual'])
       .build();

   Replace proxy middleware URLs with a URL that points to the correct endoints, and replace <replace-me-with-app-id> and <replace-me-with-api-key> with the appropriate APP-ID and APIKey for the passive liveness (remove the headers if the api doesn't need credentials or the url is pointing towards an intermediate endpoint).

   🚧

   Look Out!

   To not accidentally leak of AppID and APIKey for passive liveness, always pass them to an intermediate endpoint (like a proxy middleware) and append the AppID and APIKey header before reaching Verihubs' passive liveness service in production. Additional data can also be passed to this intermediate endpoint for end user identification.

   For more information about creating a Proxy Middleware, refer to Proxy Middleware.

   For API documentation of the Builder, refer to Builder.

6. Populate the component logic in <script setup> by the code below:

   src/App.vue

   <script setup>
   import { ref, onMounted, onBeforeUnmount } from 'vue';
   const image = ref('');
   const data = ref('');
   
   const livenessMessageListener = ({ data: { data: msgData, subject } }) => {
     switch (subject) {
       case 'Verification.Verbose':
         console.log('[Verbose]', msgData);
         break;
   
       case 'Camera.NotAllowed':
       case 'Camera.NotFound':
       case 'Camera.PermissionDenied':
       case 'ScreenOrientation.NotAllowed':
       case 'Verification.Disrupted':
       case 'Verification.Timeout':
         console.log({ data: msgData, subject });
         alert(subject);
         window.LivenessSDK.onDestroy();
         break;
   
       case 'Verification.Success':
         setTimeout(() => {
           image.value = `data:image/png;base64,${msgData.image.url}`;
           data.value = JSON.stringify(msgData, null, 2);
           window.LivenessSDK.onDestroy();
         }, 1500);
         break;
   
       default:
         console.log({ data: msgData, subject });
         alert(subject);
         break;
     }
   };
   
   const doLivenessVerification = () => {
     window.LivenessSDK.onStart();
   };
   
   onMounted(() => {
     window.addEventListener('message', livenessMessageListener);
   });
   
   onBeforeUnmount(() => {
     window.removeEventListener('message', livenessMessageListener);
   });
   </script>

📘

Info

Check System Messages for full system message references.

7. Replace the template component inside App.vue with the code below:

<template>
  <div>
    <img v-if="image" :src="image" alt="Liveness Verification Result" />
    <pre>{{ data }}</pre>
    <button @click="doLivenessVerification">Start Liveness Verification</button>
  </div>
</template>

8. Add the dependency to optimizeDeps.include and build.commonjsOptions.include in Vite.config.js with code below:

   src/Vite.config.js

   export default defineConfig({
     plugins: [vue()],
     optimizeDeps: {
       include: ["@verihubs/liveness"],
     },
     build: {
       commonjsOptions: {
         include: [/liveness/, /node_modules/],
       },
     },
   });

To try the above implementation you can run the following command from the liveness project:

npm run dev