Submit OTP

4 min

Introduction

The API allows users to fetch GST analytics data for a particular GST identification number (GSTIN) by providing an authentication token.

Sample cURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/..your-patron-id../gstanalytics \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task": "getGstAnalyticsAuthToken", "type": "Detailed", "essentials": { "requestId": 1645165505556, "gstin": [ "gstin_of_organization" ], "otp": ["otp_recieved"] }}'

Parameter Name	Description
request method	POST
URL
Accept	Specify the desired response format
Accept-Language	Specify the preferred language for the response
Authorization	Access Token for authentication
content-type	Specify the format of the request payload
task	The type of task to be performed. In this case, "getGstAnalyticsAuthToken"
type	The type of GST analytics data requested. In this case, "Detailed"
requestId	A unique ID for the request
gstin	The GST identification number of the organization
otp	The one-time password received for authentication

Sample API Response


      {
        "task": "getGstAnalyticsAuthToken",
        "type": "Detailed",
        "essentials": {
            "requestId": unique_requestId,             
            "gstin": [
                "gstin of the organization"
            ],
            "otp": ["otp_recieved"]
        },
        "id": "62053afb10b082bc3077734b",
        "patronId": "5f10016e2d5764779b1703dd",
        "result": "GSTIN Authentication Successful."
     }

Parameter	Description
task	The task to be performed, in this case, "getGstAnalyticsAuthToken"
type	The type of GST analytics data requested, in this case, "Detailed"
requestId	A unique identifier for the request
gstin	The GST identification number of the organization for which data is being requested
otp	The OTP received for authentication purposes
id	The unique identifier for the request response
patronId	The unique identifier of the patron making the request
result	A message indicating whether the GSTIN authentication was successful or not