Cashfree Payments Developer Documentation

Sandbox environment is a testing environment and responses are mocked. For real time verifications, please use the production environment.

Authorizations

x-client-id

string

header

required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

x-client-secret

string

header

required

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

Headers

x-cf-signature

string

Send the signature if two-factor authentication is selected as Public Key. More details

x-api-version

string

default:2024-12-01

required

API version to be used. Format is in YYYY-MM-DD.

Example:

"2024-12-01"

Body

multipart/form-data

Find the request parameters to perform Smart OCR verification.

verification_id

string

default:test_verification_id

required

It is the unique ID you create to identify the verification request. The maximum character limit is 50. Only alphaumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.

Example:

"test_verification_id"

document_type

enum<string>

required

Tag depicts the document type of the file being shared in the request.

Available options:

PAN,

AADHAAR,

DRIVING_LICENCE,

VOTER_ID,

PASSPORT,

VEHICLE_RC,

CANCELLED_CHEQUE,

INVOICE

Example:

"PAN"

file

required

Image of the document. Allowed file types: JPEG, JPG, PNG or PDF. The maximum size of an image and a PDF file is 5 MB and 1 MB, respectively. Conditionally required when file_url is missing. Use image file for better latency of the api.

Example:

"image"

file_url

string

default:file_url

Public URL of the image. Allowed only https URL. Allowed file types: JPEG, JPG, PNG or PDF. The maximum size of image and pdf file are 5 MB and 1 MB respectively. Conditionally required when the file is missing. Use image file link for better latency of the api.

Example:

"https://linkofFile"

do_verification

boolean

default:false

When set to true, performs real-time verification of extracted document data against government databases. Adds a verification_details section to the response with validation results. Currently supports: PAN Card and Driving Licence verification.

Example:

true

Response

Success response for retrieving the list of information associated with the mobile number.

verification_id

string

It is the unique ID shared by the merchant for each request.

Example:

"test_verification_id"

reference_id

integer

It displays the unique ID created by Cashfree Payments for document OCR reference purposes.

Example:

1358

document_type

string

The field will show the document_type shared or predicted if it is not shared in the request.

Example:

"VOTED_ID"

document_fields

object

Structure with all the relevant fields in the input image.

Show child attributes

document_fields.voter_id_number

string

It displays the voter ID number.

Example:

"ABC1234567"

document_fields.name

string

It displays the name of the voter ID holder.

Example:

"John Doe"

document_fields.guardian_name

string

It displays the name of the guardian of the voter ID holder

Example:

"Josh Doe"

document_fields.gender

string

It displays the gender of the voter ID holder.

Example:

"Male"

document_fields.date_of_birth

string

It displays the date of birth of the ID holder.

Example:

"2001-10-02"

document_fields.address

string

It displays the address of the voter ID holder.

Example:

"RMZ Eco world, Building 7 10th Floor, Devarabeesanahalli, Marathalli Outer Ring road, Bangalore - 560103"

document_fields.date_of_issue

string

It displays the date of issue of the voter ID.

Example:

"2023-08-15"

quality_checks

object

Contains all the quality checks the product performs on the given input image. Note: This field can return true, false, or null.

Show child attributes

quality_checks.blur

boolean | null

Conveys whether the image is blurred or not.

Example:

false

quality_checks.glare

boolean | null

Conveys if glare is present in the image.

Example:

false

quality_checks.partially_present

boolean | null

Conveys whether the image is partially present or not.

Example:

false

quality_checks.black_and_white

boolean | null

Conveys if the image is black and white.

Example:

true

quality_checks.face_present

boolean | null

Conveys whether the document in the image has a face present.

Example:

true

quality_checks.face_clear

boolean | null

Conveys whether the face on the document is clear.

Example:

true

quality_checks.qr_present

boolean | null

Conveys whether the document in the image has a QR.

Example:

false

quality_checks.obscured

boolean | null

Conveys whether the document in the image is obscured.

Example:

false

fraud_checks

object

It displays the personal information of the mobile number holder. Note: This field can return true, false, or null.

Show child attributes

fraud_checks.is_screenshot

boolean | null

Conveys true if the image input is a screenshot.

Example:

false

fraud_checks.is_photo_of_screen

boolean | null

Conveys true if the input photo is the photo of a screen.

Example:

false

fraud_checks.is_photo_imposed

boolean | null

Conveys true if another image imposes the photo of the face on the document.

Example:

false

fraud_checks.is_overwritten

boolean | null

Conveys true if any field on the document is overwritten.

Example:

false

fraud_checks.is_forged

boolean | null

Conveys true if any field on the document is forged.

Example:

false

qr_details

object

It displays the details extracted from QR code present on the document.

Show child attributes

qr_details.status

enum<string>

Status of the QR on the document. Possible values are:

NOT_PRESENT: QR is not present on the document.
UNPROCESSABLE: QR is present, but not processable.
SECURE: QR present is in securely encrypted format.
PRIMITIVE: QR present is of old unencrypted format. Information like photo_link, mobile_linked, email_linked, mobile_hash, email_hash is not present.

Available options:

SECURE,

PRIMITIVE,

NOT_PRESENT,

UNPROCESSABLE

Example:

"SECURE"

qr_details.name

string | null

Name of the individual.

Example:

"John Doe"

qr_details.dob

string | null

Date of birth of the individual.

Example:

"1979-01-01T00:00:00.000Z"

qr_details.gender

string | null

Gender of the individual.

Example:

"Male"

qr_details.care_of

string | null

Name of the guardian or care of.

Example:

"S / O Josh Doe"

qr_details.address

string | null

Full address of the individual.

Example:

"House No 120, M.V-30, Ward No 04, Kambeda, Orkel, Malkangiri, Kamwada, Odisha - 764051"

qr_details.split_address

object

Split address details.

Show child attributes

qr_details.split_address.country

string

Country of the address.

Example:

"India"

qr_details.split_address.dist

string

District of the address.

Example:

"Malkangiri"

qr_details.split_address.house

string

House number of the address.

Example:

"House No 120"

qr_details.split_address.landmark

string | null

Landmark near the address.

Example:

"Near ABC Complex"

qr_details.split_address.pincode

integer

Pincode of the address.

Example:

764051

qr_details.split_address.po

string

Post office of the address.

Example:

"Kambeda"

qr_details.split_address.state

string

State of the address.

Example:

"Odisha"

qr_details.split_address.street

string

Street of the address.

Example:

"M.V-30"

qr_details.split_address.subdist

string

Sub-district of the address.

Example:

"Orkel"

qr_details.split_address.vtc

string

Village or town of the address.

Example:

"Kamwada"

qr_details.split_address.locality

string

Locality of the address.

Example:

"Ward No 04"

qr_details.year_of_birth

integer | null

Year of birth of the individual.

Example:

1979

qr_details.aadhaar_last_four_digit

string | null

Last four digits of the Aadhaar number.

Example:

3783

qr_details.email_linked

boolean | null

Email linked to the Aadhaar.

Example:

true

qr_details.mobile_linked

boolean | null

Mobile number linked to the Aadhaar.

Example:

true

qr_details.mobile_hash

string | null

Hashed mobile number.

Example:

"hashed_mobile_value"

qr_details.email_hash

string | null

Hashed email address.

Example:

"hashed_email_value"

qr_details.photo_link

string | null

Link to the photo associated with the Aadhaar.

Example:

"<base64 encoded image>"

verification_details

PAN Verification Details · object

Contains detailed verification information specific to the document type being verified.

PAN Verification Details
Driving Licence Verification Details

Show child attributes

verification_details.reference_id

integer

Unique ID created by Cashfree Payments for document verification reference purposes.

verification_details.pan

string

The unique 10-character alphanumeric identifier of the individual issued by the Income Tax Department. The first 5 should be alphabets followed by 4 numbers and the 10th character should again be an alphabet.

Example:

"ABCTY1234D"

verification_details.name

string

Name of the individual as per the PAN records.

Example:

"John Doe"

verification_details.dob

string

Date of birth of the individual as per the PAN records. Format is YYYY-MM-DD

Example:

"1993-06-30"

verification_details.name_match

string

Result of name match verification. Possible values:

Y : The name entered matches with the name present on the PAN.
N : The name entered does not match with the name present on the PAN.

Example:

"Y"

verification_details.dob_match

string

Result of the date of birth verification. Possible values:

Y : The date of birth matches with the date of birth present on PAN.
N : The date of birth does not match with the date of birth present on PAN.

Example:

"Y"

verification_details.pan_status

string

Status of the PAN information. Possible values:

E : The entered PAN information is valid.
EC: The entered PAN information exists and is valid but marked as Acquisition.
N : The entered PAN information does not exist in the database.
X : The entered PAN information has been deactivated.
F : The entered PAN information is fake.
D : The entered PAN information has been deleted.
EA : The entered PAN information is valid but marked as Amalgamation.
ED : The entered PAN information is valid but marked as Death.
EI : The entered PAN information is valid but marked as Dissolution.
EL : The entered PAN information is valid but marked as Liquidated.
EM : The entered PAN information is valid but marked as Merger.
EP : The entered PAN information is valid but marked as Partition.
ES : The entered PAN information is valid but marked as Split.
EU : The entered PAN information is valid but marked as Under Liquidation.

Example:

"E"

verification_details.status

string

Status of PAN verification. Possible values:

VALID
INVALID

Example:

"VALID"

verification_details.aadhaar_seeding_status

string

Whether the individual linked the Aadhaar information with PAN. Possible values:

Y: Aadhaar is linked to PAN
R: Aadhaar is not linked to PAN
NA: Not applicable, in case of business PAN

Example:

"Y"

verification_details.aadhaar_seeding_status_desc

string

Additional information about the linking of Aadhaar and PAN card.

Example:

"Aadhaar is linked to PAN"

Secure ID APIs

V2

V1 (Depricated API's)

Smart OCR

Authorizations

Headers

Body

Response