Server Side SDKs

Install and configure Cashfree Secure ID server SDKs for Node.js, Java, Python, and PHP to call KYC and verification APIs without writing low-level REST code.

Cashfree Secure ID server-side SDKs reduce the amount of work required to call Secure ID REST APIs from your backend. Each SDK wraps authentication, request formatting, and response parsing in language-specific libraries for Node.js, Java, Python, and PHP.

Prerequisites

Complete the following before you install an SDK:

• Generate API keys and confirm your sandbox credentials. See Getting started.
• Whitelist your server IP address, or configure 2FA signature generation for API requests.

API vs SDK

Use the REST API when you need full control over HTTP requests, work in a language without an official SDK, or call only a small set of endpoints. Use an SDK when you want language-native methods, built-in authentication headers, and less boilerplate for request and response handling.

An API defines how applications send requests and receive responses, typically over a network. An SDK packages APIs with libraries, documentation, and language-specific helpers so you can call those APIs with less manual setup.

The following table compares the two approaches:

Aspect	API	SDK
Purpose	Enables interaction between systems	Facilitates application development
Scope	Focused on specific functionality	Toolkit that often includes APIs
Ease of use	Requires manual setup	Provides abstractions and ready-to-use code
Language support	Typically language-agnostic	Usually language-specific
Included tools	None	Often includes helpers, samples, and related utilities

Why use server SDKs

Server SDKs help you integrate Secure ID verification APIs faster and with fewer errors than calling REST endpoints directly. They offer the following benefits:

• Faster integration: Pre-built methods map to Secure ID API operations, so you spend less time writing HTTP clients and parsing JSON.
• Built-in authentication: SDKs attach required headers such as x-client-id, x-client-secret, and x-api-version on every request.
• Consistent error handling: API error responses are surfaced as language-native exceptions or error objects, so you do not parse HTTP status codes manually.
• Type safety: Request and response models in Java and PHP help catch parameter mistakes at compile time.
• Ongoing maintenance: SDK releases track API changes, reducing the effort required to adopt new endpoints or fields.

Supported SDKs

Cashfree maintains official server-side SDKs for the following languages. Each card links to the SDK GitHub repository for source code, changelogs, and issue tracking.

Node.js SDK

Version 4.0.1. JavaScript and TypeScript SDK for Node.js applications and serverless functions.

Java SDK

Version 2.0.10. SDK for Java applications and Spring Boot services.

Python SDK

Version 2.0.0. SDK for Python applications and data pipelines.

PHP SDK

Version 3.0.1. SDK for PHP applications and Laravel projects.

Install and configure the SDK

Select your language below, install the package, and initialise the SDK with your credentials and target environment.

Node.js

Install the package using npm:

npm install cashfree-verification

Initialise the SDK with your client ID, client secret, API version, and environment:

import { Cashfree } from "cashfree-verification";

Cashfree.XClientId = "<CLIENT_ID>";
Cashfree.XClientSecret = "<CLIENT_SECRET>";
Cashfree.XEnvironment = Cashfree.Environment.SANDBOX;
Cashfree.XApiVersion = "2024-12-01";

Java

Add the dependency to your build file.

Gradle dependency:

implementation "com.cashfree.verification.java:cashfree_verification:2.0.10"

Maven dependency:

<dependency>
  <groupId>com.cashfree.verification.java</groupId>
  <artifactId>cashfree_verification</artifactId>
  <version>2.0.10</version>
</dependency>

Initialise the SDK:

import com.cashfree.CashfreeVrs;

CashfreeVrs.XClientId = "<CLIENT_ID>";
CashfreeVrs.XClientSecret = "<CLIENT_SECRET>";
CashfreeVrs.XEnvironment = CashfreeVrs.SANDBOX;

CashfreeVrs cashfree = new CashfreeVrs();
String xApiVersion = "2024-12-01";

Python

Install the package using pip:

pip install cashfree_verification

Initialise the SDK:

from cashfree_verification import Cashfree

Cashfree.XClientId = "<CLIENT_ID>"
Cashfree.XClientSecret = "<CLIENT_SECRET>"
Cashfree.XEnvironment = Cashfree.SANDBOX
x_api_version = "2024-12-01"

PHP

Install the package using Composer:

composer require cashfree/cashfree-verification

Initialise the SDK:

\Cashfree\CashfreeVrs::$XClientId = "<CLIENT_ID>";
\Cashfree\CashfreeVrs::$XClientSecret = "<CLIENT_SECRET>";
\Cashfree\CashfreeVrs::$XEnvironment = \Cashfree\CashfreeVrs::$SANDBOX;

$cashfree = new \Cashfree\CashfreeVrs();

Do not embed your client secret in client-side code, mobile applications, or public repositories. Initialise SDKs only on trusted backend servers.

Related topics

• Bank Account Verification Sync V2 API
• PAN Lite API
• IFSC Verification V2 API
• DigiLocker React Native SDK