KYC SDK

A JavaScript SDK for integrating Know Your Customer (KYC) verification into your web applications.

Installation

npm install kyc-sdk

Usage

import KYCSDK from 'kyc-sdk';

const kyc = new KYCSDK({
  returnUrl: 'https://your-app.com/kyc-callback',
  authKey: 'client-auth-key',
  secretKey: 'client-secret-key',
  userId: 'user-123',
  username: 'John Doe'
});

// Initialize the KYC flow
kyc.init();

// To clean up after the KYC process is complete
kyc.destroy();

Configuration Options

| Option | Type | Description | Required | |--------|------|-------------|----------| | returnUrl | String | URL to redirect after KYC completion | Yes | | authKey | String | Authentication key for the KYC service | Yes | | secretKey | String | Secret key for the KYC service | Yes | | userId | String | Unique identifier for the user | No | | username | String | Name of the user | No | | elementId | String | ID of the container element (default: 'kyc-container') | No |

Features

• Permission handling (camera, microphone, location)
• Form-based identity verification
• API integration with backend services
• Responsive UI components

Development

# Install dependencies
npm install

# Build for production
npm run build

License

MIT