GST Analytics Level One Report

7 min

Description

The API endpoint allows the user to send a batch of GSTINs to Signzy for analysis, along with additional data required for analysis.

Sample Curl

curl --location --request POST
'https://api-preproduction.signzy.app/api/v3/analytics/gst-analytics/level-one-report' \
--header 'Authorization: <AuthKey>' \
--header 'Content-Type: application/json' \
--header 'Cookie: CookieConsentPolicy=0:1;
LSKey-c$CookieConsentPolicy=0:1' \
--data-raw '{
"customerID": "HDFCCLOSZY",
"gstins": [
"24AJJPG0XXXXXXX",
"29AAWCS3XXXXXXX"
],
"requestIds": [
167422014XXXX,
167422014XXXX
],
"ttl" : "2 months","callBackUrl":
"https://webhook.site/7ba1d8ac-1340-4d54-8683-62a429c42482"
}'

Request Headers

Header	Description
Authorization	The API key required to access the API endpoint. This key must be included in the header for authentication.
Content-Type	The format of the data being sent in the request body. In this case, the format is JSON.

Request Body

The request body should contain a JSON object with the following fields:

Field	Type	Required	Description
customerID	string	Yes	The unique identifier for the customer whose GSTINs are being analyzed.
gstins	array	Yes	An array of GSTINs to be analyzed.
requestIds	array	Yes	An array of request IDs for each GSTIN.
ttl	string	Yes	The time to live for the request, in the format of "number" followed by "unit" (e.g. "2 months").
callBackUrl	string	Yes	The URL to which the response will be sent after the analysis is completed.

Example Request Body:


{
    "customerID": "HDFCCLOSZY",
    "gstins": [
        "24AJJPG0741Q1Z2",
        "29AAWCS3552Q1Z6"
    ],
   "requestIds": [
        16535434669105,
        16535428995705
    ],
    "callBackUrl": "https://webhook.site/7ba1d8ac-1340-4d54-8683-62a429c42482"
}

Response Body

{
"referenceId": "dd66df44-400e-4c00-b6aa-099f90a53cf9",
"customerId": "HDFCCLOSZY",
"message": "Your Request has been successfully accepted",
"timestamp": 1674230910478
}

The response body is in JSON format and contains the following fields:

Field	Type	Description
requestId	string	The unique ID of the request that was processed.
statusCode	string	The status code of the request. Possible values are "200" and "400".
message	string	A message containing the result of the request processing.

Response Codes

The API endpoint can return the following response codes:

Response Code	Description
200	The request was processed successfully.
400	The request was not processed successfully. An error message is included in the response body.