Telr Developer Documentation

Verify GSTIN

curl --request POST \
  --url https://sandbox.cashfree.com/verification/gstin \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "GSTIN": "29AAICP2912R1ZR",
  "business_name": "UJJIVAN SMALL FINANCE BANK"
}
'

import requests

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

payload = {
    "GSTIN": "29AAICP2912R1ZR",
    "business_name": "UJJIVAN SMALL FINANCE BANK"
}
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({GSTIN: '29AAICP2912R1ZR', business_name: 'UJJIVAN SMALL FINANCE BANK'})
};

fetch('https://sandbox.cashfree.com/verification/gstin', 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/gstin",
  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([
    'GSTIN' => '29AAICP2912R1ZR',
    'business_name' => 'UJJIVAN SMALL FINANCE BANK'
  ]),
  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/gstin"

	payload := strings.NewReader("{\n  \"GSTIN\": \"29AAICP2912R1ZR\",\n  \"business_name\": \"UJJIVAN SMALL FINANCE BANK\"\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/gstin")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"GSTIN\": \"29AAICP2912R1ZR\",\n  \"business_name\": \"UJJIVAN SMALL FINANCE BANK\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"GSTIN\": \"29AAICP2912R1ZR\",\n  \"business_name\": \"UJJIVAN SMALL FINANCE BANK\"\n}"

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

{
  "reference_id": 19,
  "GSTIN": "29AAICP2912R1ZR",
  "legal_name_of_business": "UJJIVAN SMALL FINANCE BANK LIMITED",
  "trade_name_of_business": "UJJIVAN SMALL FINANCE BANK",
  "center_jurisdiction": "I-A RANGE",
  "state_jurisdiction": "GUWAHATI - A - 1",
  "date_of_registration": "2017-09-30",
  "constitution_of_business": "Public Limited Company",
  "taxpayer_type": "Regular",
  "gst_in_status": "Active",
  "last_update_date": "2022-03-01",
  "nature_of_business_activities": [
    "Retail Business",
    "Supplier of Services",
    "Recipient of Goods or Services",
    "Office / Sale Office",
    "Others"
  ],
  "principal_place_address": "First Floor 3512-DISPUR Prithivi Mansion opp. KFC building G.S. Road, Lachit Nagar Assam 781007",
  "principal_place_split_address": {
    "building_name": "Prithivi Mansion",
    "street": "G.S. Road",
    "location": "Lachit Nagar",
    "building_number": "3512-DISPUR",
    "district": "Guwahati",
    "state": "Assam",
    "city": "Dispur",
    "flat_number": "First Floor",
    "latitude": "26.1445",
    "longitude": "91.7362",
    "pincode": "781007"
  },
  "additional_address_array": [
    {
      "address": "Mirza Santipur NH-37 Dist-Kamrup Rural PS-Palashbari, PO  Mirza Kamrup Assam 781125",
      "split_address": {
        "building_name": "",
        "street": "NH-37",
        "location": "Santipur, Mirza",
        "building_number": "",
        "district": "Kamrup Rural",
        "state": "Assam",
        "city": "Palashbari",
        "flat_number": "",
        "latitude": "26.0926",
        "longitude": "91.5069",
        "pincode": "781125"
      }
    },
    {
      "address": "N.A.C.C.I. Foundation 3559-Tezpur CHAMBER BHAWAN Binjraj Road, P. o. and P.S. - Tezpur, Dist. Binjraj Road, P. o. and P.S. - Tezpur, Dist. Sonitpur Assam 784154",
      "split_address": {
        "building_name": "CHAMBER BHAWAN",
        "street": "Binjraj Road",
        "location": "Tezpur",
        "building_number": "3559-Tezpur",
        "district": "Sonitpur",
        "state": "Assam",
        "city": "Tezpur",
        "flat_number": "",
        "latitude": "26.6338",
        "longitude": "92.8006",
        "pincode": "784154"
      }
    }
  ],
  "valid": true,
  "message": "GSTIN Exists"
}

POST

gstin

Verify GSTIN

curl --request POST \
  --url https://sandbox.cashfree.com/verification/gstin \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "GSTIN": "29AAICP2912R1ZR",
  "business_name": "UJJIVAN SMALL FINANCE BANK"
}
'

import requests

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

payload = {
    "GSTIN": "29AAICP2912R1ZR",
    "business_name": "UJJIVAN SMALL FINANCE BANK"
}
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({GSTIN: '29AAICP2912R1ZR', business_name: 'UJJIVAN SMALL FINANCE BANK'})
};

fetch('https://sandbox.cashfree.com/verification/gstin', 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/gstin",
  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([
    'GSTIN' => '29AAICP2912R1ZR',
    'business_name' => 'UJJIVAN SMALL FINANCE BANK'
  ]),
  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/gstin"

	payload := strings.NewReader("{\n  \"GSTIN\": \"29AAICP2912R1ZR\",\n  \"business_name\": \"UJJIVAN SMALL FINANCE BANK\"\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/gstin")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"GSTIN\": \"29AAICP2912R1ZR\",\n  \"business_name\": \"UJJIVAN SMALL FINANCE BANK\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"GSTIN\": \"29AAICP2912R1ZR\",\n  \"business_name\": \"UJJIVAN SMALL FINANCE BANK\"\n}"

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

{
  "reference_id": 19,
  "GSTIN": "29AAICP2912R1ZR",
  "legal_name_of_business": "UJJIVAN SMALL FINANCE BANK LIMITED",
  "trade_name_of_business": "UJJIVAN SMALL FINANCE BANK",
  "center_jurisdiction": "I-A RANGE",
  "state_jurisdiction": "GUWAHATI - A - 1",
  "date_of_registration": "2017-09-30",
  "constitution_of_business": "Public Limited Company",
  "taxpayer_type": "Regular",
  "gst_in_status": "Active",
  "last_update_date": "2022-03-01",
  "nature_of_business_activities": [
    "Retail Business",
    "Supplier of Services",
    "Recipient of Goods or Services",
    "Office / Sale Office",
    "Others"
  ],
  "principal_place_address": "First Floor 3512-DISPUR Prithivi Mansion opp. KFC building G.S. Road, Lachit Nagar Assam 781007",
  "principal_place_split_address": {
    "building_name": "Prithivi Mansion",
    "street": "G.S. Road",
    "location": "Lachit Nagar",
    "building_number": "3512-DISPUR",
    "district": "Guwahati",
    "state": "Assam",
    "city": "Dispur",
    "flat_number": "First Floor",
    "latitude": "26.1445",
    "longitude": "91.7362",
    "pincode": "781007"
  },
  "additional_address_array": [
    {
      "address": "Mirza Santipur NH-37 Dist-Kamrup Rural PS-Palashbari, PO  Mirza Kamrup Assam 781125",
      "split_address": {
        "building_name": "",
        "street": "NH-37",
        "location": "Santipur, Mirza",
        "building_number": "",
        "district": "Kamrup Rural",
        "state": "Assam",
        "city": "Palashbari",
        "flat_number": "",
        "latitude": "26.0926",
        "longitude": "91.5069",
        "pincode": "781125"
      }
    },
    {
      "address": "N.A.C.C.I. Foundation 3559-Tezpur CHAMBER BHAWAN Binjraj Road, P. o. and P.S. - Tezpur, Dist. Binjraj Road, P. o. and P.S. - Tezpur, Dist. Sonitpur Assam 784154",
      "split_address": {
        "building_name": "CHAMBER BHAWAN",
        "street": "Binjraj Road",
        "location": "Tezpur",
        "building_number": "3559-Tezpur",
        "district": "Sonitpur",
        "state": "Assam",
        "city": "Tezpur",
        "flat_number": "",
        "latitude": "26.6338",
        "longitude": "92.8006",
        "pincode": "784154"
      }
    }
  ],
  "valid": true,
  "message": "GSTIN Exists"
}

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 GSTIN information

GSTIN

string

default:29AAICP2912R1ZR

required

It is the unique number assigned to businesses registered under the Goods and Services Tax (GST) system in India.

Example:

"29AAICP2912R1ZR"

business_name

string

default:UJJIVAN SMALL FINANCE BANK

It is the name of the business to which the GSTIN is issued. The maximum character limit is 200.

Example:

"UJJIVAN SMALL FINANCE BANK"

Response

Success response for retrieving GSTIN information

reference_id

integer<int64>

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

Example:

12345

GSTIN

string

Unique identification number assigned to businesses registered under the Goods and Services Tax (GST) system in India.

Example:

"29AAICP2912R1ZR"

legal_name_of_business

string

Legal name of the business registered under the GST system.

Example:

"UJJIVAN SMALL FINANCE BANK LIMITED"

trade_name_of_business

string

Trade name of the business registered under the GST system.

Example:

"UJJIVAN SMALL FINANCE BANK"

center_jurisdiction

string

Center jurisdiction under which the business falls.

Example:

"I-A RANGE"

state_jurisdiction

string

State jurisdiction under which the business falls.

Example:

"GUWAHATI - A - 1"

date_of_registration

string

Date of GST registration for the business.

Example:

"2017-09-30"

constitution_of_business

string

Constitution type of the business, such as Private Limited, Proprietorship, etc.

Example:

"Public Limited Company"

taxpayer_type

string

Taxpayer type, indicating whether the business is a Regular taxpayer, Composition taxpayer, etc.

Example:

"Regular"

gst_in_status

string

Current status of the GSTIN.

Example:

"Active"

last_update_date

string

Date when the GST details were last updated.

Example:

"2022-03-01"

nature_of_business_activities

string[]

List of activities performed by the business, such as Retail Business, Supplier of Services, etc.

Activity performed by the business, such as Retail Business, Supplier of Services, etc.

principal_place_address

string

Complete principal place address of the business.

Example:

"First Floor 3512-DISPUR Prithivi Mansion opp. KFC building G.S. Road, Lachit Nagar Assam 781007"

principal_place_split_address

object

Split components of the principal place address.

Show child attributes

additional_address_array

object[]

List of additional addresses associated with the business.

Show child attributes

valid

boolean

Indicates whether the GSTIN is valid.

message

string

The message indicates whether the GSTIN exists.