DeepVue Aadhaar eKYC SDK

A React SDK for integrating Aadhaar eKYC verification into your applications. This SDK provides a simple and secure way to implement Aadhaar-based KYC verification in your React applications.

Features

• 🔒 Secure Aadhaar eKYC integration
• 🎨 Customizable UI components
• 📱 Responsive design
• 🔄 Real-time verification status
• 🎯 Easy integration with React applications
• 📦 Supports both CommonJS and ES Modules
• 🎨 CSS Modules support
• 🚀 Optimized bundle size

Installation

npm install deepvue-aadhaar-ekyc
# or
yarn add deepvue-aadhaar-ekyc

Peer Dependencies

This package requires React 16.8.0 or higher:

{
  "peerDependencies": {
    "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^18.3.1",
    "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^18.3.1"
  }
}

Usage

import React from "react";
import { AadhaarEKYCForm } from "deepvue-aadhaar-ekyc";

function App() {
  const handleSuccess = (data) => {
    console.log("KYC successful:", data);
    // Handle successful KYC verification
  };

  return (
    <div>
      <h1>Aadhaar eKYC Integration</h1>
      <AadhaarEKYCForm
        apiKey="your_api_key"
        client_id="your_client_id"
        onSuccess={handleSuccess}
      />
    </div>
  );
}

export default App;

Props

| Prop | Type | Required | Description | | ----------- | -------- | -------- | ----------------------------------------------- | | apiKey | string | Yes | Your DeepVue API key | | client_id | string | Yes | Your client identifier | | onSuccess | function | Yes | Callback function called when KYC is successful | | onError | function | No | Callback function called when an error occurs | | className | string | No | Additional CSS class for the form container | | style | object | No | Additional inline styles for the form container |

Development

Prerequisites

• Node.js 14 or higher
• npm or yarn

Setup

1. Clone the repository:

git clone https://github.com/yourusername/deepvue-ekyc-web.git
cd deepvue-ekyc-web

2. Install dependencies:

npm install

3. Start development server:

npm run dev

Building

To build the package:

npm run build

This will create:

• CommonJS build (dist/index.js)
• ES Module build (dist/index.esm.js)
• Source maps for both

Testing Locally

1. Build the package:

npm run build

2. Link the package:

npm link

3. Create a test React application and link the package:

# In your test app directory
npm link deepvue-aadhaar-ekyc

4. Import and use the component in your test app:

import { AadhaarEKYCForm } from "deepvue-aadhaar-ekyc";

Browser Support

The package supports all modern browsers:

• Chrome (latest)
• Firefox (latest)
• Safari (latest)
• Edge (latest)

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For support, email [email protected] or open an issue in the GitHub repository.

Security

For security concerns, please email [email protected].

Changelog

1.0.0

• Initial release
• Basic Aadhaar eKYC form component
• Support for React 16.8.0 and above
• CSS Modules support
• CommonJS and ES Module builds