> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Verify GST

> Run a real-time GSTIN verification for a customer_use sub-account using a 15-character GSTIN.

Runs a real GSTIN verification for the sub-account. `gstin` must be a 15-character GSTIN. The result is persisted and the aggregated [KYC status](/sub-accounts/kyc/kyc-status) is recomputed.

<Info>
  Authenticate with your **parent main account's** `X-Auth-ID` and `X-Auth-Token` — the same credentials used everywhere else in the API.
</Info>

## Request body

| Field   | Type   | Required | Description                                                        |
| ------- | ------ | -------- | ------------------------------------------------------------------ |
| `gstin` | string | Yes      | The GSTIN. Must be exactly 15 characters (e.g. `29AAJCN5983D1Z0`). |

## Response example

```json 200 OK theme={null}
{
  "verification_type": "gst",
  "status": "verified",
  "gstin": "29AAJCN5983D1Z0",
  "legal_name": "ACME PRIVATE LIMITED"
}
```

A `400` is returned when `gstin` is not exactly 15 characters.

<Tip>
  Testing? Use the [mock endpoint](/sub-accounts/kyc/test-mode). The `gstin` must still be 15 characters — `TESTSUCCESS0001` is already 15, so pass it as-is.
</Tip>


## OpenAPI

````yaml POST /api/v1/sub-accounts/{sub_auth_id}/kyc/verify-gst
openapi: 3.0.3
info:
  title: Vobiz API
  description: >
    The Vobiz API lets you make calls, manage phone numbers, configure SIP
    trunks, 

    and access account data programmatically.


    **Base URL:** `https://api.vobiz.ai`


    **Authentication:** All requests require `X-Auth-ID` and `X-Auth-Token`
    headers.

    Obtain these from your [Vobiz Console](https://console.vobiz.ai).
  version: '1.0'
  contact:
    email: support@vobiz.ai
    url: https://vobiz.ai
servers:
  - url: https://api.vobiz.ai
    description: Production
security:
  - AuthID: []
    AuthToken: []
tags:
  - name: Account
    description: Manage your account details and credentials
  - name: Balance
    description: Retrieve balance and transaction history
  - name: Calls
    description: Make and manage outbound calls
  - name: Live Calls
    description: Retrieve and control in-progress calls
  - name: CDR
    description: Call detail records and history
  - name: Sub-Accounts
    description: Create and manage sub-accounts
  - name: Phone Numbers
    description: Manage phone numbers on your account
  - name: Trunks
    description: Configure SIP trunks for inbound and outbound calling
  - name: Conference
    description: Manage conference calls and members
  - name: Applications
    description: Manage voice and messaging applications with webhook URLs
  - name: Endpoints
    description: Manage SIP endpoints for IP phones, softphones, and SIP clients
  - name: Partner API
    description: >-
      Reseller and white-label endpoints for managing customer sub-accounts,
      balance transfers, transactions, CDRs, and DIDs across your partner
      ecosystem
  - name: Sub-Account KYC
    description: >-
      Per-sub-account KYC verification (PAN, GST, CIN, Aadhaar, DigiLocker) and
      hosted email/redirect KYC sessions. Authenticated as the parent main
      account.
  - name: Sub-Account KYC (Test Mode)
    description: >-
      Mock KYC endpoints that never call the upstream provider. Drive verified /
      failed / pending / error outcomes with magic inputs for integration
      testing.
paths:
  /api/v1/sub-accounts/{sub_auth_id}/kyc/verify-gst:
    post:
      tags:
        - Sub-Account KYC
      summary: Verify GST
      description: Runs a real GSTIN verification. `gstin` must be a 15-character GSTIN.
      operationId: verify-subaccount-gst
      parameters:
        - $ref: '#/components/parameters/SubAuthId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - gstin
              properties:
                gstin:
                  type: string
                  minLength: 15
                  maxLength: 15
                  example: 29AAJCN5983D1Z0
      responses:
        '200':
          description: Verification result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycVerificationResult'
              example:
                verification_type: gst
                status: verified
                gstin: 29AAJCN5983D1Z0
                legal_name: ACME PRIVATE LIMITED
        '400':
          description: Invalid GSTIN format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    SubAuthId:
      name: sub_auth_id
      in: path
      required: true
      description: The sub-account's Auth ID.
      schema:
        type: string
        example: SA_XXXXXX
  schemas:
    KycVerificationResult:
      type: object
      description: Outcome of a single KYC verification step.
      properties:
        verification_type:
          type: string
          enum:
            - pan
            - gst
            - cin
            - aadhaar
        status:
          type: string
          enum:
            - verified
            - failed
            - pending
        kyc_calls_blocked:
          type: boolean
          description: Recomputed sub-account call-blocking state after this verification.
        mock:
          type: boolean
          description: Present and `true` on responses from the test-mode endpoints.
      required:
        - verification_type
        - status
    Error:
      type: object
      properties:
        api_id:
          type: string
        error:
          type: string
        message:
          type: string
  securitySchemes:
    AuthID:
      type: apiKey
      in: header
      name: X-Auth-ID
      description: Your Vobiz account Auth ID
    AuthToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Your Vobiz account Auth Token

````