post https://api.instantpay.in/identity/verifyGstin
With this API, you will obtain information such as GSTIN Status (Active/Suspended/Cancelled), company name, and address, providing a comprehensive insight into the GST compliance status of your clientele. Enhance operational efficiency and minimise risks associated with non-compliance by incorporating Instantpay's GSTIN Verification API solution into your identity verification toolkit.
Header Parameters
| Name | Type | Description | Mandatory (M) , Optional (O) | Provided by INSTANTPAY (Y/N) |
|---|---|---|---|---|
| X-Ipay-Auth-Code | String | Auth Code -1 (Fixed) | M | Y |
| X-Ipay-Client-Id | String | Unique Client ID | M | Y |
| X-Ipay-Client-Secret | String | Unique secret key | M | Y |
| X-Ipay-Endpoint-Ip | String | End Customer IP Address | M | N |
Request Parameters
| Name | Type | Mandatory (M) , Optional (O) | Description |
|---|---|---|---|
| gstNumber | String | M | GST Number of Company |
| externalRef | String | M | Your Unique Transaction Id |
| lattitude | String | M | End Customer Latitude. |
| longitude | String | M | End Customer Longitude. |
Sample Request
curl --location --request POST 'https://api.instantpay.in/identity/verifyGstin' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"gstNumber" : "24D**********ZY",
"externalRef" :"123456789",
"latitude" : "25.**41",
"longitude" : "85.**76"
}'
POST /identity/verifyGstin HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Type: application/json
{
"gstNumber" : "24D**********ZY",
"externalRef" :"123456789",
"latitude" : "25.**41",
"longitude" : "85.**76"
}
Response Parameters
| Name | Type | Description |
|---|---|---|
| statuscode | String | InstantPay Status Code |
| actcode | String | Action Code |
| status | String | Status message |
| data | Array | Response Data (If Present) |
| timestamp | String | Current time (YYYY-MM-DD HH:II:SS) |
| ipay_uuid | String | Request reference number |
| orderid | String | Transaction Id ( If transaction otherwise it is null ) |
| environment | String | Live/Sandbox |
Note :
1- externalRef must be unique and in alpha numeric characters.
2- Latitude and Longitude must be represented in degrees with 4 digits after decimal.
Sample Response
{
"statuscode": "TXN",
"actcode": null,
"status": "Transaction Successful",
"data": {
"pool": {
"referenceId": "1220**********LKPR",
"openingBalance": "16.82",
"paymentAmount": "1.18",
"mode": "DR",
"closingBalance": "15.64"
},
"gstDetails": {
"gstin": "24D**********ZY",
"lgnm": "*******************",
"stj": "******** (Surat)",
"ctj": "R*********I",
"rgdt": "05/01/2022",
"ctb": "Proprietorship",
"dty": "Regular",
"nba": [
"Supplier of Services",
"Retail Business",
"Wholesale Business"
],
"sts": "Active",
"cxdt": "",
"tradeNam": "Payby Digital Service",
"stjCd": "GJ067",
"ctjCd": "VC0303",
"pradr": {
"addr": {
"bnm": "********** ********",
"st": "KHOLVAD ROAD",
"loc": "KAMREJ",
"bno": "SHOP NO. 01",
"stcd": "Gujarat",
"flno": "FIRST FLOOR",
"lt": "",
"lg": "",
"dst": "Surat",
"city": "",
"pncd": "394190"
},
"ntr": "Supplier of Services, Retail Business, Wholesale Business"
},
"adadr": [],
"filingFreq": null,
"lastUpdated": "31/Mar/2022"
}
},
"timestamp": "2022-04-05 14:35:12",
"ipay_uuid": "h00695fd4116-152b-4fd0-864e-22e7c9ce4bbb",
"orderid": "12************KPR",
"environment": "LIVE",
"internalCode": null
}