How to use GST Prism?

This solution works in 4 steps -

Create Request/Create GSTR Authlink - Using this API, the timeframe for which the report is to be generated and the selection of data required is to be selected. This API will then trigger the OTP to the registered mobile number on the GST portal for authentication. Apart from this, using the Create GSTR Auth link, the RM agent/Salesperson/Field officer can also trigger a DIY journey for authenticating GST credentials. It sends a link to the email and mobile number of the CA/Director(whoever will have the GST Credentials) and help them complete the authorization so that an analytics report can be created out that data.

Submit OTP - This API will be used to submit the OTP which was generated in the last step. Once the OTP is submitted successfully, a session with the GST portal is established through which raw data, i.e. Invoice-level data of the filings done on the GST portal will be downloaded and an analytics report be generated.

Fetch Data - This API will be used to fetch the raw invoice-level data which is downloaded from the GST portal and can be kept for the record.

Fetch Report - This API is used to fetch the analytics report. Signzy currently gives 3 formats of reports -

Dummy Data - The incorporation of dummy data within the GSTR Analytics Prism API serves as a pivotal tool for testing and development purposes. This feature enables users to emulate requests and responses without the necessity of engaging with the authentic GST portal or utilizing real GST data. Specifically designed for ease during the development phase, this functionality seamlessly integrates into the existing create-request endpoint. By specifying certain parameters in your API requests, you can simulate responses featuring dummy data in structured JSON, Excel, and PDF reports.

OTP Flow - Similar to the conventional create-request API, the OTP flow introduces a distinctive twist. Instead of providing the actual GSTIN/username, users can input the dummy GSTIN/username/OTP combinations provided by Signzy. Following this, the subsequent steps remain consistent, requiring the submission of the OTP alongside the obtained requestId. Post-authentication, users can effortlessly retrieve dummy data directly from the fetch-report endpoint in various formats, such as JSON, PDF, and Excel.

Password Flow - The password flow offers a streamlined approach by allowing users to specify the authentication type (authType) and password within the create-request API. This eliminates the need to navigate through the submit-OTP step. Upon furnishing the necessary details in the create-request API, users can promptly fetch dummy data from the fetch-report endpoint, utilizing the acquired requestId. The flexibility of directly obtaining dummy data simplifies the testing process.

Dummy Data Values:

GSTIN	Username	Password	OTP
29ABCDE1234F1Z5	signzy8e_1	signzyGSTA8e_1	777777
27ABCDE1234F1Z9	signzyBe_2	signzyGSTBe_2	777777

Please refer to the next sections for a detailed API specification.