Telr Developer Documentation

Verify Driving Licence Details

curl --request POST \
  --url https://sandbox.cashfree.com/verification/driving-license \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "verification_id": "test001",
  "dl_number": "KA0120198900984",
  "dob": "1994-08-05"
}
'

import requests

url = "https://sandbox.cashfree.com/verification/driving-license"

payload = {
    "verification_id": "test001",
    "dl_number": "KA0120198900984",
    "dob": "1994-08-05"
}
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({verification_id: 'test001', dl_number: 'KA0120198900984', dob: '1994-08-05'})
};

fetch('https://sandbox.cashfree.com/verification/driving-license', 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/driving-license",
  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([
    'verification_id' => 'test001',
    'dl_number' => 'KA0120198900984',
    'dob' => '1994-08-05'
  ]),
  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/driving-license"

	payload := strings.NewReader("{\n  \"verification_id\": \"test001\",\n  \"dl_number\": \"KA0120198900984\",\n  \"dob\": \"1994-08-05\"\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/driving-license")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"verification_id\": \"test001\",\n  \"dl_number\": \"KA0120198900984\",\n  \"dob\": \"1994-08-05\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/verification/driving-license")

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  \"verification_id\": \"test001\",\n  \"dl_number\": \"KA0120198900984\",\n  \"dob\": \"1994-08-05\"\n}"

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

{
  "verification_id": "69c5077c-d95a-48cb-b428-4ced025db671",
  "reference_id": 76,
  "dl_number": "KA51201900089895",
  "dob": "1994-08-05",
  "status": "VALID",
  "badge_details": [
    {
      "badge_issue_date": null,
      "badge_no": null,
      "class_of_vehicle": [
        "LMV"
      ]
    }
  ],
  "dl_validity": {
    "non_transport": {
      "to": "09/05/2039",
      "from": "10/05/2019"
    },
    "hazardous_valid_till": null,
    "transport": {
      "to": null,
      "from": null
    },
    "hill_valid_till": null
  },
  "details_of_driving_licence": {
    "date_of_issue": "10/05/2019",
    "date_of_last_transaction": null,
    "status": null,
    "last_transacted_at": null,
    "name": "JOHN DOE",
    "father_or_husband_name": "JOHN DOE",
    "address_list": [
      {
        "complete_address": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103",
        "type": "permanent",
        "split_address": {
          "district": [
            "BANGALORE"
          ],
          "state": [
            [
              "KARNATAKA",
              "KA"
            ]
          ],
          "city": [
            "BELLANDUR"
          ],
          "pincode": "560103",
          "country": [
            "IN",
            "IND",
            "INDIA"
          ],
          "address_line": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103"
        }
      },
      {
        "complete_address": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103",
        "type": "temporary",
        "split_address": {
          "district": [
            "BANGALORE"
          ],
          "state": [
            [
              "KARNATAKA",
              "KA"
            ]
          ],
          "city": [
            "BELLANDUR"
          ],
          "pincode": "560103",
          "country": [
            "IN",
            "IND",
            "INDIA"
          ],
          "address_line": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103"
        }
      }
    ],
    "address": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103",
    "split_address": {
      "district": [
        "BANGALORE"
      ],
      "state": [
        ""
      ],
      "city": [
        "BELLANDUR"
      ],
      "pincode": "560103",
      "country": [
        "IN",
        "IND",
        "INDIA"
      ],
      "address_line": "FLAT NO D-901 SUNCITY,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103"
    },
    "cov_details": []
  }
}

POST

driving-license

Verify Driving Licence Details

curl --request POST \
  --url https://sandbox.cashfree.com/verification/driving-license \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "verification_id": "test001",
  "dl_number": "KA0120198900984",
  "dob": "1994-08-05"
}
'

import requests

url = "https://sandbox.cashfree.com/verification/driving-license"

payload = {
    "verification_id": "test001",
    "dl_number": "KA0120198900984",
    "dob": "1994-08-05"
}
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({verification_id: 'test001', dl_number: 'KA0120198900984', dob: '1994-08-05'})
};

fetch('https://sandbox.cashfree.com/verification/driving-license', 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/driving-license",
  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([
    'verification_id' => 'test001',
    'dl_number' => 'KA0120198900984',
    'dob' => '1994-08-05'
  ]),
  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/driving-license"

	payload := strings.NewReader("{\n  \"verification_id\": \"test001\",\n  \"dl_number\": \"KA0120198900984\",\n  \"dob\": \"1994-08-05\"\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/driving-license")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"verification_id\": \"test001\",\n  \"dl_number\": \"KA0120198900984\",\n  \"dob\": \"1994-08-05\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/verification/driving-license")

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  \"verification_id\": \"test001\",\n  \"dl_number\": \"KA0120198900984\",\n  \"dob\": \"1994-08-05\"\n}"

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

{
  "verification_id": "69c5077c-d95a-48cb-b428-4ced025db671",
  "reference_id": 76,
  "dl_number": "KA51201900089895",
  "dob": "1994-08-05",
  "status": "VALID",
  "badge_details": [
    {
      "badge_issue_date": null,
      "badge_no": null,
      "class_of_vehicle": [
        "LMV"
      ]
    }
  ],
  "dl_validity": {
    "non_transport": {
      "to": "09/05/2039",
      "from": "10/05/2019"
    },
    "hazardous_valid_till": null,
    "transport": {
      "to": null,
      "from": null
    },
    "hill_valid_till": null
  },
  "details_of_driving_licence": {
    "date_of_issue": "10/05/2019",
    "date_of_last_transaction": null,
    "status": null,
    "last_transacted_at": null,
    "name": "JOHN DOE",
    "father_or_husband_name": "JOHN DOE",
    "address_list": [
      {
        "complete_address": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103",
        "type": "permanent",
        "split_address": {
          "district": [
            "BANGALORE"
          ],
          "state": [
            [
              "KARNATAKA",
              "KA"
            ]
          ],
          "city": [
            "BELLANDUR"
          ],
          "pincode": "560103",
          "country": [
            "IN",
            "IND",
            "INDIA"
          ],
          "address_line": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103"
        }
      },
      {
        "complete_address": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103",
        "type": "temporary",
        "split_address": {
          "district": [
            "BANGALORE"
          ],
          "state": [
            [
              "KARNATAKA",
              "KA"
            ]
          ],
          "city": [
            "BELLANDUR"
          ],
          "pincode": "560103",
          "country": [
            "IN",
            "IND",
            "INDIA"
          ],
          "address_line": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103"
        }
      }
    ],
    "address": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103",
    "split_address": {
      "district": [
        "BANGALORE"
      ],
      "state": [
        ""
      ],
      "city": [
        "BELLANDUR"
      ],
      "pincode": "560103",
      "country": [
        "IN",
        "IND",
        "INDIA"
      ],
      "address_line": "FLAT NO D-901 SUNCITY,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103"
    },
    "cov_details": []
  }
}

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.

Body

application/json

Find the request paramenters to retrieve your customer's driving license information

verification_id

string

default:test001

required

It is the unique ID you create to identify the verification request. A maximum of 50 characters are allowed. Only alphanumeric, period (.), hyphen (-) and underscore ( _ ) are allowed.

Example:

"test001"

dl_number

string

default:KA0120198900984

required

It is the driving licence number of the individual for verification.

Example:

"KA0120198900984"

dob

string

default:1994-08-05

required

It is the date of birth of the individual as present in the driving licence. The accepted format is YYYY-MM-DD.

Example:

"1994-08-05"

Response

Success response for retrieving the driving licence information

verification_id

string

It displays the unique ID you created to identify this API request.

Example:

"test001"

reference_id

integer

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

Example:

78

dl_number

string

It displays the unique number assigned to the driving licence.

Example:

"JK01FG8087"

dob

string

It displays the date of birth of the individual as present in the driving licence.

Example:

"2001-10-23"

status

string

It displays the status of the driving licence. Possible values are

VALID: driving license is valid.
INVALID: driving licence is invalid.

Example:

"VALID"

badge_details

object[]

It contains the...

Show child attributes

dl_validity

object

It contains the different information regarding the validity of the licence.

Show child attributes

details_of_driving_licence

object

It contains the details of the driving licence.

Show child attributes

Example:

{
  "value": {
    "date_of_issue": "10/05/2019",
    "date_of_last_transaction": null,
    "status": null,
    "last_transacted_at": null,
    "name": "JOHN DOE",
    "father_or_husband_name": "JOHN DOE",
    "address_list": [
      {
        "complete_address": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103",
        "type": "permanent",
        "split_address": {
          "district": ["BANGALORE"],
          "state": ["KARNATAKA", "KA"],
          "city": ["BELLANDUR"],
          "pincode": "560103",
          "country": ["IN", "IND", "INDIA"],
          "address_line": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103"
        }
      },
      {
        "complete_address": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103",
        "type": "temporary",
        "split_address": {
          "district": ["BANGALORE"],
          "state": ["KARNATAKA", "KA"],
          "city": ["BELLANDUR"],
          "pincode": "560103",
          "country": ["IN", "IND", "INDIA"],
          "address_line": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103"
        }
      }
    ],
    "address": "FLAT NO D-901 SUN,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103",
    "split_address": {
      "district": ["BANGALORE"],
      "state": [""],
      "city": ["BELLANDUR"],
      "pincode": "560103",
      "country": ["IN", "IND", "INDIA"],
      "address_line": "FLAT NO D-901 SUNCITY,BELLANDUR, BANGALORE SOUTH,BANGALORE,KA 560103",
      "cov_details": []
    }
  }
}