Overview

Verify OTP API takes in the gstin ,username & otp to verify the OTP generated to enable access to the GST Portal.

About

This API will start a session and provide access valid for 6 hours. Returns date timestamp of the expiry of the session.
The end result of Tax Payer authentication process is to establish an authorization token for the session which needs to be included in the header for all subsequent API calls

Endpoint

HTTP Method	Resource	Description
`POST`	/gsp/tax-payer/{gstin}/otp/verify?username={username}&otp={otp}	This API takes in the `gstin`, `otp` and `username` to start the session to access the `gstin`'s GST Portal.

Request

Follow the below guidelines to verify the OTP.

Path Parameter

Param	Type	Description	Example
gstin	`string`	15-character alphanumeric unique identifier assigned to business entities registering under the GST regime	22AAAAA0000A1Z5

Query Parameter

Param	Type	Description	Example
username	`string`	Username same as used in GST portal.	[email protected]
otp	`string`	OTP Recieved from the previous step.	1231

curl --request POST \
     --url 'https://api.sandbox.co.in/gsp/tax-payer/22AAAAA0000A1Z5/otp/verify?username=xxxxx%40gmail.com&otp=1231' \
     --header 'Authorization: xxxxxxxxxx' \
     --header 'accept: application/json' \
     --header 'x-api-key: xxxxxxxxxx' \
     --header 'x-api-version: 1.0'

Response

Param	Type	Description	Example
session_expiry	`num`	Epoch time when the session expires for the authenticated Taxpayer	1623316504835
expiry	`num`	Time in minutes for the GST Portal API access to get disabled	43200