Kver.js

A lightweight TypeScript library for document verification supporting multiple identity documents and KYC service providers.

Features

• 🚀 Easy to use API
• 🔒 Type-safe
• 🔌 Adapter-based architecture
• ⚡ Promise-based async operations
• 📦 Multiple KYC provider support
• 📄 Multi-document verification support (currently Aadhaar, with more coming soon)

Installation

npm install @mohit4bug/kver-js
# or
yarn add @mohit4bug/kver-js
# or
pnpm add @mohit4bug/kver-js

Quick Start

import { Kver, SurepassAadhaarAdapter } from '@mohit4bug/kver-js'

// Initialize the adapter with your Surepass bearer token
const adapter = new SurepassAadhaarAdapter({ 
  bearerToken: 'YOUR_BEARER_TOKEN' 
})

// Create a new Kver instance
const kver = new Kver({ 
  adapter, 
  documentType: 'aadhaar' // Support for more document types coming soon
})

// Example usage with Aadhaar
async function verifyDocument() {
  try {
    // Generate OTP
    const otpResponse = await kver.adapter.generateOtp({ 
      aadhaarNumber: '123456789012' 
    })
    console.log('OTP Generated, Client ID:', otpResponse.clientId)

    // Verify OTP
    const verificationResponse = await kver.adapter.verifyOtp({
      clientId: otpResponse.clientId,
      otp: '123456'
    })
    console.log('Verification successful:', verificationResponse.data)
  } catch (error) {
    console.error('Verification failed:', error)
  }
}

Response Types

OTP Generation Response

interface IGenerateOtpResponse {
  clientId: string
  statusCode: number
}

Verification Response

// Aadhaar verification response
interface IVerifyOtpResponse {
  data: {
    gender: string
    fullName: string
    careOf: string
    dob: string
    address: {
      house: string
      street: string
      vtc: string
      loc: string
    }
    zip: string
    profileImage: string
  }
}

// Additional document type responses will be added in future releases

Available Adapters

Current Adapters

SurepassAadhaarAdapter

The SurepassAadhaarAdapter integrates with Surepass's Aadhaar verification API.

const adapter = new SurepassAadhaarAdapter({ 
  bearerToken: 'YOUR_BEARER_TOKEN' 
})

Upcoming Adapters

We are actively working on adding support for more document types and service providers. Stay tuned for updates!

Error Handling

The library throws typed exceptions that you can catch and handle:

• ServiceUnavailableException: Thrown when the KYC service is unavailable
• Additional error types may be thrown based on the specific adapter and document type being used

Roadmap

• Support for PAN card verification
• Support for Driving License verification
• Additional KYC service provider integrations
• Enhanced validation and error handling for different document types

Contributing

Contributions are welcome! Whether it's adding support for new document types, implementing new service provider adapters, or improving existing functionality, please feel free to submit a Pull Request.

License

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

Author

Mohit Khatri (mohit4bug)

Version

Current version: 1.6.0-beta.1