Telr Developer Documentation

Get Status.

curl --request GET \
  --url https://sandbox.cashfree.com/verification/pan/bulk \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'

import requests

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

headers = {
    "x-client-id": "<api-key>",
    "x-client-secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-client-id': '<api-key>', 'x-client-secret': '<api-key>'}
};

fetch('https://sandbox.cashfree.com/verification/pan/bulk', 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/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-client-id", "<api-key>")
	req.Header.Add("x-client-secret", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.cashfree.com/verification/pan/bulk")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "bulk_verification_id": 1123456,
  "reference_id": 615,
  "count": 2,
  "entries": [
    {
      "pan": "ABCPV1234D",
      "type": "Individual",
      "reference_id": 1320143,
      "name_provided": "John",
      "registered_name": "John Snow",
      "father_name": "",
      "valid": true,
      "message": "PAN verified successfully",
      "name_match_score": 85,
      "name_match_result": "GOOD_PARTIAL_MATCH",
      "aadhaar_seeding_status": "Y",
      "last_updated_at": "26/05/2017",
      "name_pan_card": "JOHN SNOW",
      "pan_status": "VALID",
      "aadhaar_seeding_status_desc": "Aadhaar is linked to PAN"
    },
    {
      "pan": "ABCPV1239K",
      "type": "Individual",
      "reference_id": 132014,
      "name_provided": "Jone",
      "registered_name": "Jone Doe",
      "father_name": "",
      "valid": true,
      "message": "PAN verified successfully",
      "name_match_score": 85,
      "name_match_result": "GOOD_PARTIAL_MATCH",
      "aadhaar_seeding_status": "Y",
      "last_updated_at": "26/05/2019",
      "name_pan_card": "JONE DOE",
      "pan_status": "VALID",
      "aadhaar_seeding_status_desc": "Aadhaar is linked to PAN"
    }
  ]
}

GET

pan

bulk

Get Status.

curl --request GET \
  --url https://sandbox.cashfree.com/verification/pan/bulk \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'

import requests

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

headers = {
    "x-client-id": "<api-key>",
    "x-client-secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-client-id': '<api-key>', 'x-client-secret': '<api-key>'}
};

fetch('https://sandbox.cashfree.com/verification/pan/bulk', 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/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-client-id", "<api-key>")
	req.Header.Add("x-client-secret", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.cashfree.com/verification/pan/bulk")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "bulk_verification_id": 1123456,
  "reference_id": 615,
  "count": 2,
  "entries": [
    {
      "pan": "ABCPV1234D",
      "type": "Individual",
      "reference_id": 1320143,
      "name_provided": "John",
      "registered_name": "John Snow",
      "father_name": "",
      "valid": true,
      "message": "PAN verified successfully",
      "name_match_score": 85,
      "name_match_result": "GOOD_PARTIAL_MATCH",
      "aadhaar_seeding_status": "Y",
      "last_updated_at": "26/05/2017",
      "name_pan_card": "JOHN SNOW",
      "pan_status": "VALID",
      "aadhaar_seeding_status_desc": "Aadhaar is linked to PAN"
    },
    {
      "pan": "ABCPV1239K",
      "type": "Individual",
      "reference_id": 132014,
      "name_provided": "Jone",
      "registered_name": "Jone Doe",
      "father_name": "",
      "valid": true,
      "message": "PAN verified successfully",
      "name_match_score": 85,
      "name_match_result": "GOOD_PARTIAL_MATCH",
      "aadhaar_seeding_status": "Y",
      "last_updated_at": "26/05/2019",
      "name_pan_card": "JONE DOE",
      "pan_status": "VALID",
      "aadhaar_seeding_status_desc": "Aadhaar is linked to PAN"
    }
  ]
}

Authorizations

x-client-id

string

header

required

Client ID. You can find your ID in the Merchant Dashboard.

x-client-secret

string

header

required

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

x-cf-signature

string

Send the signature if IP is not whitelisted.

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

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
}