gst-overview-data

GST Details - Batch APIs

Retrieve paginated GST registration info for each GSTIN associated with an order.

Authentication and Order Setup

Before calling this API:

1. Refer to the Authentication section to obtain a valid sessionID.
2. Refer to the Create Order API documentation to create an order and obtain the corresponding order_id.

Note: Use the sessionID as the Bearer token for authentication and the order_id as a query parameter for this endpoint.

Endpoint

GET https://micro.signalx.ai/micro-check-api/gst/v2/get_gst_overview_data
Authorization: Bearer <your_jwt_token>

Query parameters

Parameter	Type	Required	Description	Example
order_id	String	Yes	Unique identifier of the order	3d73bea2-ec1c...
page	Integer	Yes	Page number	1
page_size	Integer	Yes	Records per page	5

cURL Example

curl --location 'https://micro.signalx.ai/micro-check-api/gst/v2/get_gst_overview_data?order_id=3d73bea2-ec1c-4a21-9876-abc123def456&page=1&page_size=100' \
--header 'Authorization: Bearer <JWT_TOKEN>'

Sample Response

{
  "status_code": 200,
  "total": 5000,
  "total_pages": 50,
  "data": [
    {
      "gstin": "27ABACS6684C1ZY",
      "legal_name_of_business": "SAMPLE VENDOR PRIVATE LIMITED",
      "trade_name": "Sample Vendor",
      "effective_date_of_registration": "2018-07-01",
      "constitution_of_business": "Private Limited",
      "gstin_uin_status": "Active",
      "whether_aadhaar_authenticated": true,
      "whether_e_kyc_verified": true,
      "goods": [
        { "hsn": 30049099, "description": "PHARMACEUTICAL PRODUCTS" }
      ]
    }
  ],
  "message": "Success"
}

Key response fields (per item)

Field	Type	Description
gstin	String	GST Identification Number
legal_name_of_business	String	Legal name of the registered business
trade_name	String	Trade name of the business
effective_date_of_registration	String	Date when GST registration became effective
constitution_of_business	String	Entity type (e.g. Proprietorship)
gstin_uin_status	String	Status (e.g. Active, Cancelled)
whether_aadhaar_authenticated	Boolean	Aadhaar authentication completion status
whether_e_kyc_verified	Boolean	e‑KYC verification completion status
goods / services	Array	List of HSN codes and descriptions

---