Cashfree Payments Developer Documentation

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

It is the API version. To receive the aadhaar seeding status in the response, use any date after 2022-09-12

Query Parameters

reference_id

string

default:1234567

required

It is the unique ID created by Cashfree Payments that you receive in the response of Verify PAN in Bulk API.

bulk_verification_id

string

default:BV234253

required

It is the unique ID you created to identify the Verify PAN in Bulk API request.

Response

Success response for verifying a large number of PAN information

bulk_verification_id

string

It displays the unique ID created by you to identify the bulk verification request.

Example:

"1123456"

reference_id

string

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

Example:

"515"

count

integer<int64>

Example:

1

entries

object[]

It contains the details of PAN for verification.

Minimum array length: 1

Show child attributes

entries.pan

string

It displays the unique 10-character alphanumeric identifier issued by the Income Tax Department.

Example:

"ABCPV1234D"

entries.type

string

It displays the type of the PAN issued.

Example:

"Individual"

entries.reference_id

integer<int64>

It displays the unique ID created by Cashfree Payments for reference purposes. format: int64

Example:

161

entries.name_provided

string

It displays the name entered in the API request.

Example:

"JOHN DOE"

entries.registered_name

string

It displays the PAN registered name.

Example:

"JOHN DOE"

entries.valid

boolean

It displays the status of the PAN card.

Example:

true

entries.father_name

string

It displays the father's name of the PAN card holder.

Example:

""

entries.message

string

It displays details about the success or failure of the API request.

Example:

"PAN verified successfully"

entries.name_match_score

string

It displays the score for the name match verification.

Example:

"100.00"

entries.name_match_result

string

It displays the result of the name match verification. Possible values are:

DIRECT_MATCH
GOOD_PARTIAL_MATCH
MODERATE_PARTIAL_MATCH
POOR_PARTIAL_MATCH
NO_MATCH

Example:

"DIRECT_MATCH"

entries.aadhaar_seeding_status

string

It displays additional information of the linking of aadhaar and PAN card. Possible values are:

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

Example:

"Y"

entries.last_updated_at

string

It displays the last updated date.

Example:

"01/01/2019"

entries.name_pan_card

string

It displays the name displayed on the PAN card.

Example:

"JOHN DOE"

entries.pan_status

string

It displays the status of the PAN card. Possible values are:

VALID
INVALID
DELETED
DEACTIVATED

Example:

"VALID"

entries.aadhaar_seeding_status_desc

string

It displays additional information of the linking of aadhaar and PAN card.

Example:

"Aadhaar is linked to PAN"

Example:

{
  "father_name": "John Doe",
  "message": "VALID",
  "name_match_result": "PARTIAL",
  "name_match_score": "0.7",
  "name_provided": "John De",
  "pan": "ABCDP3011E",
  "reference_id": 1234567,
  "registered_name": "John Doe",
  "status_code": "VALID",
  "type": "Individual",
  "valid": true
}

Secure ID APIs

V2

V1 (Depricated API's)

Get Status.

Authorizations

Headers

Query Parameters

Response