Submit OTP

Introduction

This API is responsible for submitting an OTP on behalf of the client for establishing a authenticated session for fetching raw GSTR data and analytics report. 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.signzy.app/api/v3/gstr-analytics/submit-otp' \
--header 'Authorization: <Access Token>' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "d54becdf-05d9-49b9-9af8-7c93ae2772a4",
    "otp":"123456"
}'

Request Headers

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

Request Body

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

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
requestId	The requestId that was created during Generate OTP API call	String	COMPULSORY
otp	The OTP that was sent to registered device by making Generate OTP API call	String	COMPULSORY

Response Data

{
    "result": {
        "status": "SUCCESS",
        "message": "GSTIN Authentication Successful."
    }
}

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
result	This parameter contains the actual output.	Object	COMPULSORY
status	This serves as an enum to indicate the status of the API call. Possible values - SUCCESS, FAILED	String	COMPULSORY
message	It indicates whether the OTP was successfully authenticated or not	String	COMPULSORY

Status Codes & Messages

{
    "result": {
        "status": "SUCCESS",
        "message": "GSTIN Authentication Successful."
    }
}

1. GSTIN Authentication Successful.
2. GST OTP generation successful.
3. Request is already submitted and is in progress.
4. GSTIN Authentication Unsuccessful.

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].