Cashfree VRS Node SDK

The Cashfree VRS Node SDK offers a convenient solution to access Cashfree VRS APIs from a server-side JavaScript applications.

Documentation

Cashfree's Verification Suite API Documentation - https://docs.cashfree.com/reference/verification-api-overview

Learn and understand verification workflows at Cashfree Payments here

Try out our interactive guides at Cashfree Dev Studio !

Getting Started

Installation

1npm i cashfree-verification

Configuration

1import { Cashfree } from "cashfree-verification"; 
2
3Cashfree.XClientId = "<x-client-id>";
4Cashfree.XClientSecret = "<x-client-secret>";
5Cashfree.XEnvironment = Cashfree.Environment.SANDBOX;

Generate your API keys (x-client-id , x-client-secret) from Cashfree Merchant Dashboard

Basic Usage

VoterId Verification

1var request = {
2    "verification_id": 'uniqueVerificationId',
3    "epic_number": 'UAI4574761',
4    "name": 'John Doe',
5}
6
7Cashfree.VrsVoterIdVerification(request).then((response) => {
8    console.log('Verification Response:', response.data);
9})
10.catch((error) => {
11    console.error('Error in verification request:', error);
12});

Liveliness Check

1const image = fs.createReadStream(<path-to-image>);
2Cashfree.VrsLivelinessCheck("uniqueVerificationId",image).then((response) => {
3    console.log('Verification Response:', response.data);
4})
5.catch((error) => {
6    console.error('Error in verification request:', error);
7});

Supported Resources

Licence

Apache Licensed. See LICENSE.md for more details