Telr Developer Documentation

Verify CIN

curl --request POST \
  --url https://sandbox.cashfree.com/verification/cin \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "verification_id": "ABC00123",
  "cin": "U72900KA2015PTC082988"
}
'

import requests

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

payload = {
    "verification_id": "ABC00123",
    "cin": "U72900KA2015PTC082988"
}
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: 'ABC00123', cin: 'U72900KA2015PTC082988'})
};

fetch('https://sandbox.cashfree.com/verification/cin', 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/cin",
  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' => 'ABC00123',
    'cin' => 'U72900KA2015PTC082988'
  ]),
  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/cin"

	payload := strings.NewReader("{\n  \"verification_id\": \"ABC00123\",\n  \"cin\": \"U72900KA2015PTC082988\"\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/cin")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"verification_id\": \"ABC00123\",\n  \"cin\": \"U72900KA2015PTC082988\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"ABC00123\",\n  \"cin\": \"U72900KA2015PTC082988\"\n}"

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

{
  "verification_id": "ABC00123",
  "reference_id": 12345,
  "status": "VALID",
  "cin": "U72900KA2015PTC082988",
  "company_name": "COMPANY NAME",
  "registration_number": 82987,
  "incorporation_date": "2015-09-23",
  "cin_status": "ACTIVE",
  "email": "abc@xyz.com",
  "incorporation_country": "INDIA",
  "director_details": [
    {
      "din": "07168822",
      "name": "Frank Kelvin",
      "dob": "1997-07-21",
      "designation": "DIRECTOR",
      "address": "ST BED KORAMANGALA, BANGALORE, KARNATAKA, INDIA, 566634"
    },
    {
      "din": "07168826",
      "name": "John Doe",
      "dob": "1997-02-07",
      "designation": "DIRECTOR",
      "address": " GAUTAM NAGAR, NOIDA, UTTAR PRADESH, INDIA, 211361"
    }
  ]
}

POST

cin

Verify CIN

curl --request POST \
  --url https://sandbox.cashfree.com/verification/cin \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "verification_id": "ABC00123",
  "cin": "U72900KA2015PTC082988"
}
'

import requests

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

payload = {
    "verification_id": "ABC00123",
    "cin": "U72900KA2015PTC082988"
}
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: 'ABC00123', cin: 'U72900KA2015PTC082988'})
};

fetch('https://sandbox.cashfree.com/verification/cin', 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/cin",
  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' => 'ABC00123',
    'cin' => 'U72900KA2015PTC082988'
  ]),
  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/cin"

	payload := strings.NewReader("{\n  \"verification_id\": \"ABC00123\",\n  \"cin\": \"U72900KA2015PTC082988\"\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/cin")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"verification_id\": \"ABC00123\",\n  \"cin\": \"U72900KA2015PTC082988\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"ABC00123\",\n  \"cin\": \"U72900KA2015PTC082988\"\n}"

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

{
  "verification_id": "ABC00123",
  "reference_id": 12345,
  "status": "VALID",
  "cin": "U72900KA2015PTC082988",
  "company_name": "COMPANY NAME",
  "registration_number": 82987,
  "incorporation_date": "2015-09-23",
  "cin_status": "ACTIVE",
  "email": "abc@xyz.com",
  "incorporation_country": "INDIA",
  "director_details": [
    {
      "din": "07168822",
      "name": "Frank Kelvin",
      "dob": "1997-07-21",
      "designation": "DIRECTOR",
      "address": "ST BED KORAMANGALA, BANGALORE, KARNATAKA, INDIA, 566634"
    },
    {
      "din": "07168826",
      "name": "John Doe",
      "dob": "1997-02-07",
      "designation": "DIRECTOR",
      "address": " GAUTAM NAGAR, NOIDA, UTTAR PRADESH, INDIA, 211361"
    }
  ]
}

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 parameters to retrieve your customer's CIN information

verification_id

string

default:ABC00123

required

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

Example:

"ABC00123"

cin

string

default:U72900KA2015PTC082988

required

It is the unique alphanumeric identifier assigned to companies registered under the Ministry of Corporate Affairs, India.

Example:

"U72900KA2015PTC082988"

Response

Success response for retrieving the CIN information

verification_id

string

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

Example:

"ABC00123"

reference_id

integer

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

Example:

1358

status

string

It displays the status of the CIN information. Possible values are: - VALID: CIN provided is valid - INVALID: CIN provided is invalid

Example:

"VALID"

cin

string

It displays the entered CIN information.

Example:

"U72900KA2015PTC082988"

company_name

string

It displays the name of the company registered under the Ministry of Corporate Affaris.

Example:

"COMPANY NAME"

registration_number

number

It displays the registration number of the company.

Example:

82987

incorporation_date

string

It displays the date of incorporation of the company.

Example:

"23-09-2015"

cin_status

string

It displays the granular level status of the CIN information.

Example:

"ACTIVE"

string

It displays the email ID of the company registered under the Ministry of Company Affairs.

Example:

"abc@xyz.com"

incorporation_country

string

It displays the name of the country where the company is located.

Example:

"INDIA"

director_details

object[]

Show child attributes