Professional Documents
Culture Documents
Exposing API To Third Parties For Validating A GSTIN
Exposing API To Third Parties For Validating A GSTIN
Exposing API To Third Parties For Validating A GSTIN
Customer Benefit
● Never have a wrong GSTIN for your Vendor/Customer in your ERP system/Product Onboarding
● Avoid GST Compliance errors
● Improve overall efficiency by reducing back and forth due to mistakes in GSTINs
● Get Addi onal details
Input
User will provide the input as GSTIN to the API for valida on
API Response
Against a string input, API can have the following responses
1. Response with valid GSTIN input → 200 OK
2. Response with invalid GSTIN input
a. Invalid GSTIN format(regex invalid) → 400 Bad Request
b. Valid GSTIN format, but GSTIN is not exis ng/invalid → 200 OK with empty data
3. Any other System failure → 500 Internal Server Error
a. Failure due to GSTN being non responsive or under Down mes.
b. Failure at ClearTax to connect with third party or GSTN (<0.01% occurrence on 10L
randomly sampled API calls in a month)
swagger: '2.0'
basePath: /gst
info:
version: '0.0'
tle: ''
tags:
- name: CommonsResource
paths:
/v0.1/common/search_taxpayer:
get:
tags:
- CommonsResource
summary: Search Taxpayer Details By GSTIN
descrip on: ''
opera onId: searchTaxPayerDetails
consumes:
- applica on/json
produces:
- applica on/json
parameters:
- name: gs n
in: query
required: true
type: string
responses:
'200':
descrip on: Taxpayer Details
schema:
$ref: '#/defini ons/SearchTaxpayerResponse'
'401':
descrip on: Not authorized
defini ons:
SearchTaxpayerResponse:
type: object
proper es:
gs n:
type: string
example: 29AAGCC4236P1Z5
descrip on: GSTIN
lgnm:
type: string
example: CONSULTING ROOMS PRIVATE LIMITED
descrip on: Legal Business Name
stj:
type: string
example: LVO 015 - BENGALURU
descrip on: State Jurisdic on
ctj:
type: string
example: RANGE-III
descrip on: Centre Jurisdic on
rgdt:
type: string
example: 01/07/2017
descrip on: Date Of Registar on
ctb:
type: string
example: Proprietorship
descrip on: Cons tu on Of Business
dty:
type: string
example: Regular
descrip on: TaxPayer Type
nba:
type: array
descrip on: Nature Of Business Ac vity
items:
type: string
sts:
type: string
example: Ac ve
descrip on: GSTIN Status
cxdt:
type: string
example: 31/12/2017
descrip on: Date of Cancella on