React Live Face SDK

Dikript ReactJs Live Face SDK is a React-based library for integrating liveness detection functionality into your web applications. It provides a simple way to perform facial liveness checks using the Dikript API.

Features

• Easy-to-use React component for liveness detection
• Integration with Dikript API for facial liveness checks
• Customizable UI elements
• Handles API communication and error handling

Installation

To install the React Live Face SDK, run the following command in your project directory:

npm install dikript-react-live-face-sdk

Usage

Here's a basic example of how to use the React Live Face SDK in your application:

import React, { useState } from 'react';
import { LivenessPopup } from 'react-live-face-sdk';

const App = () => {
  const [showPopup, setShowPopup] = useState(false);
  const [livenessResult, setLivenessResult] = useState(null);

  const apiKey = "your_api_key_here";
  const name = "Your App Name";
  const apiUrl = "https://api.dikript.com/dikript/api/v1/biometrics/livelinesscheck";

  const startLivenessCheck = () => {
    setShowPopup(true);
    setLivenessResult(null);
  };

  const closePopup = () => {
    setShowPopup(false);
    setLivenessResult(null);
  };

  const handleLivenessResult = (result) => {
    console.log('Liveness result:', result);
    setLivenessResult(result);
  };

  return (
    <div id="app">
      <button onClick={startLivenessCheck}>Start Liveness Check</button>
      {showPopup && (
        <LivenessPopup
          apiKey={apiKey}
          name={name}
          apiUrl={apiUrl}
          onClose={closePopup}
          onLivenessResult={handleLivenessResult}
        />
      )}
      {livenessResult && (
        <div>
          <h3>Liveness Check Result:</h3>
          <pre>{JSON.stringify(livenessResult, null, 2)}</pre>
          <button onClick={closePopup}>Close</button>
        </div>
      )}
    </div>
  );
};

export default App;

API Reference

LivenessPopup Component

The LivenessPopup component is the main component for integrating liveness detection.

Props:

• apiKey (string, required): Your Dikript API key
• name (string, required): The name of your application
• apiUrl (string, required): The URL for the Dikript liveness check API
• onClose (function, required): Callback function to close the popup
• onLivenessResult (function, required): Callback function to handle the liveness check result

Development

To set up the project for development:

1. Clone the repository
2. Install dependencies:

   npm install

3. Start the development server:

   npm start

Building

To build the project for production:

npm run build

This will create a production-ready build in the build folder.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License

Support

For support, please contact Dikript Solutions at [email protected]..