Generate OTP
Taxpayer will be authenticated asynchronously using OTP(One Time Password). Sandbox API to generate OTP.
Overview
Generate OTP API takes in the gstin & username as per the GST Portal. And then sends OTP to the phone number and email id of the GST Taxpayer.
OTP Message
OTP Message is as follows:
**OTP Message Sent to the Taxpayer**
Dear taxpayer,
{{OTP}} is the OTP to verify your GST registration: {{GSTIN}}.
OTP is valid till {{hh:mm:ss IST}}. Do not share OTP with anyone.
OTP Validity
OTP sent will be valid for only 10 minutes.
Endpoint
| HTTP Method | Resource | Description |
|---|---|---|
POST | /gsp/tax-payer/{gstin}/otp | The API takes in gstin & username to generate Mobile OTP and Email OTP. |
Request
Follow the below guidelines to generate 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] |
Sample CURL request
curl --request POST \
--url 'https://api.sandbox.co.in/gsp/tax-payer/24AAACJ3770E2ZZ/otp?username=xyz' \
--header 'Authorization: eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw' \
--header 'accept: application/json' \
--header 'x-api-key: key_live_Ade**************************Uxs' \
--header 'x-api-version: 1.0'
Test Environment Not Available
Response
| Param | Type | Description | Example |
|---|---|---|---|
| message | string | Whether OTP was sent successfully or not. | OTP Generated Successfully |
Updated about 1 month ago