Verify One Time Password

Test Data

Use these API data to test out GSTIN Verification APIs. Please note that details other than the ones mentioned below will result in Invalid response.

GSTIN

OTP

Response

Remarks

24AAACJ3770E2ZV

748596

200

GSTIN verified successfully

08AAACS8577K1ZP

142536

200

Invalid session

post
Verify One Time Password

https://api.sandbox.co.in/gst-portal/tax-payers/:gstin/otp/verify?otp={{otp}}
Verify OTP to authenticate taxpayers.
Request
Response
Request
Path Parameters
gstin
required
string
15-character alphanumeric unique identifier assigned to business entities registering under the GST regime
Headers
Authorization
required
string
JWT Authorization token
x-api-key
required
string
Public key required to authorize API access.
x-api-version
optional
string
Query Parameters
otp
required
string
One time password
Response
200: OK
GSTIN verified successfully
Invalid OTP
Invalid session
Untitled
GSTIN verified successfully
{
"data": {
"message": “GSTIN verified successfully"
}
"code": 200,
"timestamp": 1616657388923,
"transaction_id": "206bafdf-af4c-44d3-a591-35d32b2454cf"
}
Invalid OTP
{
"data": {
"message": "Invalid OTP"
},
"code": 200,
"timestamp": 1614696176218,
"transaction_id": "611335dc-8be4-40d1-8438-b86526462939"
}
Invalid session
{
"data": {
"message": "Invalid session"
},
"code": 200,
"timestamp": 1614696176218,
"transaction_id": "611335dc-8be4-40d1-8438-b86526462939"
}
{
"data": {
"error_code": "SWEB_9035"
"message": "Invalid GSTIN / UID"
},
"code": 200,
"timestamp": 1614696176218,
"transaction_id": "611335dc-8be4-40d1-8438-b86526462939"
}
403: Forbidden
Access denied
Invalid token
Insufficient credits
Access denied
{
"code": 403,
"message": "Access denied",
"timestamp": 1614696176218,
"transaction_id": "611335dc-8be4-40d1-8438-b86526462939"
}
Invalid token
{
"code": 403,
"message": "Invalid access token",
"timestamp": 1614696176218,
"transaction_id": "611335dc-8be4-40d1-8438-b86526462939"
}
Insufficient credits
{
"code": 403,
"message": "Insufficient credits",
"timestamp": 1614696176218,
"transaction_id": "611335dc-8be4-40d1-8438-b86526462939"
}
422: Unprocessable Entity
Invalid GSTIN pattern
Invalid GSTIN pattern
{
"code": 422,
"message": "Invalid GSTIN pattern",
"timestamp": 1614696176218,
"transaction_id": "611335dc-8be4-40d1-8438-b86526462939"
}
500: Internal Server Error
Internal Server Error
Internal Server Error
{
"code": 500,
"message": "Internal Server Error",
"timestamp": 1614696176218,
"transaction_id": "611335dc-8be4-40d1-8438-b86526462939"
}

OTPs will be valid for 10 minutes.

JWT Authorization token can be obtained by calling the Authenticate API

Example Request

cURL
Java
Node.js
Puthon
cURL
curl --location --request POST 'https://api.sandbox.co.in/gst-portal/tax-payers/24AAACJ3770E2ZZ/otp/verify?otp=123456' \
--header 'Authorization: eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw' \
--header 'x-api-key: key_live_Ade**************************Uxs' \
--header 'x-api-version: 3.4.0'
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://api.sandbox.co.in/gst-portal/tax-payer/24AAACJ3770E2ZZ/otp/verify?otp=123456")
.header("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw")
.header("x-api-key", "key_live_Ade**************************Uxs")
.header("x-api-version", "3.4.0")
.asString();
Node.js
var https = require('follow-redirects').https;
var fs = require('fs');
var options = {
'method': 'POST',
'hostname': 'https://api.sandbox.co.in',
'path': '/gst-portal/tax-payer/24AAACJ3770E2ZZ/otp/verify?otp=123456',
'headers': {
'Authorization': 'eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw',
'x-api-key': 'key_live_Ade**************************Uxs',
'x-api-version': '3.4.0'
},
'maxRedirects': 20
};
var req = https.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
req.end();
Puthon
import requests
url = "https://api.sandbox.co.in/gst-portal/tax-payer/24AAACJ3770E2ZZ/otp/verify?otp=123456"
payload = {}
headers = {
'Authorization': 'eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw',
'x-api-key': 'key_live_Ade**************************Uxs',
'x-api-version': '3.4.0'
}
response = requests.request("POST", url, headers=headers, data = payload)
print(response.text.encode('utf8'))