Skip to main content
POST
/
pan
Verify
curl --request POST \
  --url https://sandbox.cashfree.com/verification/pan \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "pan": "ABCPV1234D",
  "name": "Gurav"
}
'
import requests

url = "https://sandbox.cashfree.com/verification/pan"

payload = {
"pan": "ABCPV1234D",
"name": "Gurav"
}
headers = {
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
'x-client-id': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({pan: 'ABCPV1234D', name: 'Gurav'})
};

fetch('https://sandbox.cashfree.com/verification/pan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.cashfree.com/verification/pan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pan' => 'ABCPV1234D',
'name' => 'Gurav'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sandbox.cashfree.com/verification/pan"

payload := strings.NewReader("{\n \"pan\": \"ABCPV1234D\",\n \"name\": \"Gurav\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/verification/pan")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pan\": \"ABCPV1234D\",\n \"name\": \"Gurav\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/verification/pan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pan\": \"ABCPV1234D\",\n \"name\": \"Gurav\"\n}"

response = http.request(request)
puts response.read_body
{
  "pan": "ABCPV1234D",
  "type": "Individual",
  "reference_id": 161,
  "name_provided": "JOHN DOE",
  "registered_name": "JOHN DOE",
  "valid": true,
  "message": "PAN verified successfully",
  "name_match_score": 100,
  "name_match_result": "DIRECT_MATCH",
  "aadhaar_seeding_status": "Y",
  "last_updated_at": "01/01/2019",
  "name_pan_card": "JOHN DOE",
  "pan_status": "VALID",
  "aadhaar_seeding_status_desc": "Aadhaar is linked to PAN"
}
The name returned by the API may differ from the name printed on the physical PAN card. The API returns the registered name from the Income Tax Departmentโ€™s records, which is the authoritative source and may not match the name displayed on the card.

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.

Body

application/json

Find the request parameters to verify PAN.

pan
string
default:ABCPV1234D
required

It is 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:

"ABCPV1234D"

name
string
default:John Doe

It is the name of the individual as per the PAN records. In case of special characters, only space, dot (.), hyphen (-), slash (/), and ampersand (&) are allowed.

Example:

"John Doe"

Response

Success response for verifiying PAN information.

pan
string

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

Example:

"ABCPV1234D"

type
string

It displays the type of the PAN issued.

Example:

"Individual"

reference_id
integer<int64>

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

Example:

161

name_provided
string

It displays the name entered in the API request.

Example:

"JOHN DOE"

registered_name
string

It displays the PAN registered name.

Example:

"JOHN DOE"

valid
boolean

It displays the status of the PAN card.

Example:

true

father_name
string

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

Example:

""

message
string

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

Example:

"PAN verified successfully"

name_match_score
string

It displays the score for the name match verification.

Example:

"100.00"

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"

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"

last_updated_at
string

It displays the last updated date.

Example:

"01/01/2019"

name_pan_card
string

It displays the name displayed on the PAN card.

Example:

"JOHN DOE"

pan_status
string

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

  • VALID
  • INVALID
  • DELETED
  • DEACTIVATED
Example:

"VALID"

aadhaar_seeding_status_desc
string

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

Example:

"Aadhaar is linked to PAN"