---
title: "Generate Otp"
method: POST
path: "/v1/gst/tax-payer/generate-otp"
tags: ["GST Taxpayer APIs"]
---

# Generate Otp

`POST /v1/gst/tax-payer/generate-otp`

## Request

- Base URL: `https://api.deepvue.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.deepvue.ai/v1/gst/tax-payer/generate-otp`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `authorize`
- TypeScript: <https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide/docs/v1/gst/tax-payer/generate-otp/post.ts> (a function with typed inputs; its response is checked against the schema)

First the taxpayer has to allow access to the GST Portal and enable it on his own GST Portal Account.   

Follow the following steps to do the same:   
    Step 1️⃣ : Login to your GST Account on https://gst.gov.in   
    Step 2️⃣ : Click '*View Profile*' on Dashboard   
    Step 3️⃣ : In the '*Quick Links*' section, go to *Manage API Access*     
    Step 4️⃣ : Set '*Enable API Access Request*' to *Yes*   
    Step 5️⃣ : Set '*Duration*' to *30days*   

- Once the taxpayer has enabled API access onto GST Portal, the OTP verification can be carried out.   
- First, Generate One Time Password API is called.   
- This API takes in the gstin & username as per GST Portal. And then sends OTP to the phone number and email id of the GST Taxpayer.    

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 sent will be valid for 10 minutes.

## Query parameters

- `gstin_number` string, required
- `user_name` string, required

## Response `200`

Successful Response

- RESPONSEGSTINGENERATEOTPSUCCESSFUL
  - `code` integer
  - `timestamp` integer, required
  - `transaction_id` string, required
  - `data` object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `422`: Validation Error
- `500`: Internal Server Error

---

[API](https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide.md) - [All operations](https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide/llms.txt) - [OpenAPI document](https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide/revisions/c1b0558e7d77?raw)
