GST Application

About

  • Business can add additional place of business, upload documents, track application, view previous submissions
    on GST portal using these APIs,

Usecase

  • E-commerce websites like Amazon, Udaan, in order for them to provides faster delivery of goods needs Sellers (Businesses) to have goods stored at dedicated fulfillment centers. Thus Sellers optioning for such services are required to add those fulfillment center as addition place of business.

Get Applications

Endpoint

HTTP Method

Resource

Description

GET

/gst-portal/tax-payer/registration/applications

Returns list of application in draft

API EndpointAPI Endpoint

Response

List of application in draft

Param

Type

Description

Example

creation_dt

string

Application creation date

18/08/2021

form_no

string

GST Registration Form

GST REG-14

expiry_dt

string

Application expiry date

02/09/2021

form_desc

string

GST Registration form description

Application for Amendment of Non-Core fields in Registration Particulars (For all types of registered persons)

draft_id

number

Application id

30465657

version_id

number

Version

3

grefId

string

Reference Id

T240000498406

state_cd

string

State code

24

status

string

Application status

Pending for Validation

appcd

string

Application code

APLAN


Draft Application

Endpoint

Used to draft an application

HTTP Method

Resource

Description

GET

/gst-portal/tax-payer/registration/applications/draft

The API takes in amendment fields type and returns application id

API EndpointAPI Endpoint


Save Additional place of business

Endpoint

HTTP Method

Resource

Description

POST

/gst-portal/tax-payer/registration/applications/core/apob/{application_id}/save

This API takes in list of additional place of business and returns document hash.

API EndpointAPI Endpoint

Request

Addition place of business entity

Param

Type

Description

Example

ntbz

array (required)

Nature of Business activity

[ "FMF","WHD, "SOS"]
See Nature of Business Reference API

natureOfChange

string (required)

Nature of change

Addition

add

address entity (required)

Address entity

contdtls

contact entity (required)

Contact entity

psnt

string (required)

Nature of possession

OWN, REN
See Nature of Possession Reference API

up_type

string (required)

Uploaded document type

RLAT, ELCB
See Document type API

rdcupdtls

array (required)

List of document

Document entity

rs

string (required)

Reason

dtamd

string (required)

Date of amendment

10/08/2021

Address entity

Param

Type

Description

Example

bno

string (required) (60 chars max)

Building number

C6-89

flno

string (optional) (60 chars max)

Floor number

4th

bnm

string (optional) (60 chars max)

Building Name

Uniworld

st

string (required) (60 chars max)

Street

Electronic city

loc

string (required) (60 chars max)

Locality

Neeladdri

dst

string (required) (5 chars max)

District

KABNU
See District Reference API

pncd

integer (required) (6 digits max)

Pin Code

560100

stcd

integer (required) (2 digits max)

State

26

Contact entity

Param

Type

Description

Example

tlphno

telephone entity (optional)

Telephone entity

fxno

fax entity (optional)

Fax entity

mbno

integer (required) (10 digits max)

Mobile Number

9988774455

em

string (optional) (String with ‘@’ ,’_’,’.’ allowed)

Email Id

[email protected]

Telephone entity

Param

Type

Description

Example

telNum

integer (8 digits max)

Telephone number

12345678

stdCd

string

STD code

040

Fax entity

Param

Type

Description

Example

fxNum

integer (16 digits max)

Fax number

442081234567

stdCd

string

STD code

040

Document entity

Param

Type

Description

Example

id

string (required)

Document id

2021082466594

ty

string (required)

Uploaded document type

RLAT, ELCB
See Document type API

ct

string (required)

Content-type

application/json

docName

string (required)

Document name

Rent.pdf

hash

string (required)

Document hash

b7d4e5e1d8420b4e3abe62344618b74e5e1bc49af1b4e710c70f13cca368d100

Response

Param

Type

Description

Example

aplId

string

Application id

30124700

stscd

string

Application hash id

80b8b6c13626987e272b9d8f44b50f7d9f1cfe82330ff1d0392ae0e9dd0f0203

errors

string

Errors


Delete Application

Endpoint

Used to delete an application in draft

HTTP Method

Resource

Description

DELETE

/gst-portal/tax-payer/registration/applications/{application_id}

API EndpointAPI Endpoint


Get Application History

Endpoint

HTTP Method

Resource

Description

GET

/gst-portal/tax-payer/registration/applications/history

Returns application history

API EndpointAPI Endpoint

Response

Application details

Param

Type

Description

Example

subdt

string

Application submission date

16/08/2021

frmno

string

GST Registration Form

GST REG-14

frmdc

string

GST Registration form description

Application for Amendment of Non-Core fields in Registration Particulars (For all types of registered persons)

applnId

integer

Application id

30465657

gstRefId

string

Reference Id

T240000498406

updateTmstmp

integer

Update timestamp

1629098537000

arn

string

Application arn

AA2408210745852

applnCd

string

Application code

APLAN


Submit Application using OTP : Generate OTP

Endpoint

HTTP Method

Resource

Description

POST

/gst-portal/tax-payer/registration/applications/{application_id}/otp

This API takes in PAN of authorized signatory, if not OTP is sent to first authorized signatory in list and returns details of authorized signatory.

API EndpointAPI Endpoint

Response

Authorized signatory details

Param

Type

Description

Example

mbno

string

Mobile number

9xxxxxxxxx3

em

string

Email id

[email protected]

fn

string

First name

BxxxxK

mn

integer

Middle name

JxxxxxxxxL

ln

string

Last name

PxxxL

dg

integer

Designation

PROPRIETOR

stscd

string

Status code

1

tranId

string

Transaction id

a50fc0ff197f404b8a36dc953cd09228

errors

string

Errors


Submit Application using OTP : Verify OTP

Endpoint

HTTP Method

Resource

Description

POST

/gst-portal/tax-payer/registration/applications/{application_id}/otp/submit

This API takes in otp and transaction id and returns status of submission

API EndpointAPI Endpoint

Request

Param

Type

Description

Example

otp

string (required)

One time password

20F195

tranId

string (required)

Transaction id

3f84a82e34a3461a8afc89e0fef0bd4b

Response

Param

Type

Description

Example

stscd

string

State code

1

message

string

Message

SUCCESS

errors

string

Errors


Did this page help you?