Create request
This API is the first step in using the GST Prism product.
This API is responsible for generating a single OTP for the client which would later be used for establishing a session for fetching GSTR data and creating analytics reports. OTP will be sent to the registered number on the GST portal. This API can also be used to submit the username and password if the end customer has opted for that authentication mechanism. The GST Prism API supports fetching up to 3 years of data. For longer durations, contact your sales representative for a customization. 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] or your sales representative for this.
Key | Value |
Authorization | shared by Signzy |
Content-type | application/json |
Input Mapping
PARAMETERS | DESCRIPTION | TYPE | VALUE (COMPULSORY OR OPTIONAL) |
gstin | GSTIN of the business/customer for which the analytics report/raw data is to be generated/fetched | String | COMPULSORY |
username | Username of the entity on GST portal for which the authorization is being done | String | COMPULSORY |
fromDate | Starting date (MMYYYY format) from which the analytics report is to be generated | String | COMPULSORY |
toDate | Ending date (MMYYYY format) till which the analytics report is to be generated | String | COMPULSORY |
entityDetails | Shall the report consist of entity details of the provided GSTIN? | Boolean | OPTIONAL |
pdfUrl | Shall the report be generated in PDF format as well? | Boolean | OPTIONAL |
callbackUrl | The URL which will be used to publish raw GST data | String | OPTIONAL |
authType | The type of authentication being used to take consent. Default is OTP if not passed | string, only accepts - "OTP"/ "PASSWORD" | OPTIONAL in case of OTP. Compulsory if going with Password authentication |
password | Password for the GST portal corresponding to the GSTIN and username provided | String | OPTIONAL, in case of authorization type of password, it is mandatory |
PARAMETERS | DESCRIPTION | TYPE | VALUE (COMPULSORY OR OPTIONAL) |
result | This parameter contains the actual output. | Object | COMPULSORY |
requestId | This is a unique 36-character long alphanumeric string created during the successful generation of OTP/submission of password and to be used for subsequent GSTR APIs | String | COMPULSORY |
message | It indicates whether the OTP generation step was successful or not. | String | COMPULSORY |
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].