Verify OTP

Taxpayer will be authenticated asynchronously using OTP(One Time Password). Sandbox API to verify the OTP.

API Pricing Image

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

API Endpoint  Contact Us  Free Trial

Request

Follow the below guidelines to verify the OTP.

Path Parameter

ParamTypeDescriptionExample
gstinstring15-character alphanumeric unique identifier assigned to business entities registering under the GST regime22AAAAA0000A1Z5

Query Parameter

ParamTypeDescriptionExample
usernamestringUsername same as used in GST portal.[email protected]
otpstringOTP 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

ParamTypeDescriptionExample
session_expirynumTime when the session expires for this GST Portal Access.1623316504835