dikript-vue-identity-comparison-sdk
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

Dikript Vue Identity Comparison SDK

Overview

Dikript VueJs Identity Comparison SDK is a powerful Vue.js component library for integrating identity comparison and liveness checks into your web applications. This SDK provides an easy-to-use interface for capturing user photos, performing liveness checks, and integrating with Dikript's biometric API.

Features

  • Live camera feed for face detection
  • Real-time face landmark detection
  • Liveness check functionality
  • Identity comparison functionality
  • Customizable UI components
  • Easy integration with Vue.js applications

Installation

npm install dikript-vue-identity-comparison-sdk

Usage

  1. Import and register the SDK in your Vue.js application:
import { createApp } from 'vue'
import App from './App.vue'
import DikriptVueIdentityComparisonSDK from 'dikript-vue-identity-comparison-sdk'

const app = createApp(App)
app.use(DikriptVueIdentityComparisonSDK)
app.mount('#app')
  1. Use the IdentityComparisonPopup component in your Vue template:
<template>
  <div>
    <button @click="startIdentityVerification">Start Identity Verification</button>
    <IdentityComparisonPopup
      v-if="showPopup"
      :apiKey="apiKey"
      :name="name"
      :apiUrl="apiUrl"
      @closePopup="closePopup"
      @identityComparisonResult="handleIdentityComparisonResult"
    />
  </div>
</template>

<script>
export default {
  data() {
    return {
      showPopup: false,
      apiKey: "your_api_key_here",
      name: "Your App Name",
      apiUrl: "https://api.dikript.com/dikript/api/v1/biometrics",
    };
  },
  methods: {
    startIdentityVerification() {
      this.showPopup = true;
    },
    closePopup() {
      this.showPopup = false;
    },
    handleIdentityComparisonResult(result) {
      console.log('Identity comparison result:', result);
      // Handle the identity comparison result
    }
  }
};
</script>

API Reference

IdentityComparisonPopup Props

  • apiKey (String, required): Your Dikript API key
  • name (String, required): The name of your application
  • apiUrl (String, required): The URL for the identity comparison API endpoint

IdentityComparisonPopup Events

  • closePopup: Emitted when the popup is closed
  • identityComparisonResult: Emitted with the result of the identity comparison

Development

To set up the project for development:

  1. Clone the repository
  2. Install dependencies: npm install
  3. Start the development server: npm run dev

Building

To build the SDK for production:

npm run build

Testing

  • Run unit tests: npm run test:unit
  • Run end-to-end tests: npm run test:e2e

License

This project is licensed under the MIT License.

Support

For any questions or support, please contact Dikript Solutions at tech@dikript.com.

Package Sidebar

Install

npm i dikript-vue-identity-comparison-sdk

Weekly Downloads

1

Version

1.0.0

License

MIT

Unpacked Size

17.2 MB

Total Files

24

Last publish

Collaborators

  • dikripttech