Create GSTR Authlink
This API is responsible for initiating Customer Consent for GSTR Analytics by providing a unique Authentication Link. The user of this API can create the consent request on behalf of the customers by providing relevant GST details of the customer along with the mailing address and/or mobile numbers for whom they want to initiate the GSTR Analytics. A Notification will be sent to the provided contact details along with a unique link. Upon successful completion of Customer verification, the GSTR analytics report will be sent to the user's provided callback URL. 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 get in touch with [email protected] for this.
Key | Value |
Authorization | shared by Signzy |
Content-type | application/json |
PARAMETERS | DESCRIPTION | TYPE | VALUE (COMPULSORY OR OPTIONAL) |
gstin | GSTIN of the business/customer for which the analytics report is to be generated | String | COMPULSORY |
username | Username of the customer as per GST portal who has to authorize the GST data fetch | String | OPTIONAL |
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 GSTR details for the provided GSTIN? | Boolean | OPTIONAL |
pdfUrl | Shall the report be generated in PDF? | Boolean | OPTIONAL |
callbackUrl | The URL which will be used to publish raw GST data | String | COMPULSORY |
emails | The list of emails where the notification would be sent along with Authlink | Array of String | OPTIONAL |
mobileNumber | The list of mobile numbers where the notification would be sent along with Authlink | Array of String | OPTIONAL |
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 successful generation of Authlink | String | COMPULSORY |
message | It indicates whether the Authlink has been successfully initiated or not | String | COMPULSORY |
authlink | This parameter enables customer to provide consent for fetching the report by the requester/user | 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].