Fetch Data

Introduction

This API is responsible for generating a consolidated GSTR raw data based on the requestId that was created during OTP Generation. You will require an authorization token to use this API. This authorization token will be generated by Signzy for you and will be used in each API call. Please contact [email protected] for this.

cURL

curl --location --globoff 'https://api-preproduction.signzy.app/api/v3/gstr-analytics/fetch-data' \
--header 'Authorization: <Access-Token>' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "d54becdf-05d9-49b9-9af8-7c93ae2772a4"
}

Request Headers

Key	Value
Authorization	Shared by Signzy
Content-type	application/json

Request Body

{
    "requestId": "d54becdf-05d9-49b9-9af8-7c93ae2772a4"
}

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
requestId	The requestId that was created during Generate OTP API call	String	COMPULSORY

Response Data

{
    "result": {
        "requestId": "d54becdf-05d9-49b9-9af8-7c93ae2772a4",
        "gstin": "12ABCDE3456X7YZ",
        "gstr1": {...},
        "gstr2a": {...},
        "gstr2b": {...},
        "gstr3b": {...}
    }
}

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
requestId	This is an unique 36 character long alphanumeric string created during successful generation of OTP and to be used for subsequent GSTR APIs	String	OPTIONAL
gstin	GSTIN of the business/customer for which the GSTR raw data is generated	String	OPTIONAL
gstr1	GSTR1 raw data segragated monthwise for the following APIs - B2B, B2CL, B2CS, AT, CDNR, CDNUR, EXP, RETSUM, NIL, etc.	String	OPTIONAL
gstr2a	GSTR2A raw data segragated monthwise for the following APIs - B2B, CDN, IMPG, IMPGSEZ, etc.	String	OPTIONAL
gstr2b	GSTR2B raw data segragated monthwise for AllDetails	String	OPTIONAL
gstr3b	GSTR3B raw data segragated monthwise for RETSUM	String	OPTIONAL
status	This serves as an enum to indicate the status of the API call. Possible values - SUCCESS, FAILED	String	OPTIONAL
message	It indicates whether the OTP was successfully authenticated or the request is still in progress	String	OPTIONAL

Status Codes

{
    "result": {
        "status": "SUCCESS",
        "message": "Request is in progress."
    }
}
1. OTP is generated. Please proceed with the submit otp API to start processing.
2. Request is in progress.
3. OTP has expired. Please retry from OTP generation.

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].