> ## Documentation Index
> Fetch the complete documentation index at: https://deepvue-2e0dbadd.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GST Advanced

> This API takes in the gstin of a business entity and provides you the information of the business entities as registered on the GST Portal.

Verifies basic GSTIN Details alongside advanced ones such as point of contact email & mobile, annual turnover and filing status and many more...



## OpenAPI

````yaml GET /v1/verification/gstin-advanced
openapi: 3.0.2
info:
  title: Deepvue.tech Developers' Guide
  description: >-
    Deepvue.tech's APIs and SDKs are a No-Code Solution to Document Digitization
    and Verification for Businesses.
  version: v1
  x-logo:
    url: https://deepvue.tech/wp-content/uploads//2022/01/deepvue-logo1-1.svg
servers:
  - url: https://production.deepvue.tech
security:
  - BearerAuth: []
    ApiKeyAuth: []
tags:
  - name: Authorization
    description: |-
      - You need an Authorized Access Token to access any of the Platform APIs.
      - One Access Token will be valid for only 24 hours.
      - After 24 hours, you can renew the token by using the Authorize Endpoint.
      - This will issue another access_token valid for 24 hrs.
  - name: Aadhaar Ekyc V2
    description: New streamlined APIs for Aadhaar eKYC
  - name: Offline Aadhaar eKYC
    description: >-
      Offline Aadhaar KYC, or OKYC, is a legally compliant KYC method as per
      UIDAI guidelines.   
                              Your customers can provide their Aadhaar number and verify with an OTP sent to their Aadhaar-linked mobile number, to access a downloadable XML file with their Aadhaar details.   

      **How does Offline Aadhaar Verification work?**    
                              **Provide Consent**:  Customers agree or disagree to continue at the initial screen.   
                              **Share Aadhaar Number**: Customers provide their Aadhaar number to proceed with the verification.   
                              **Verify with OTP**: Verify with an OTP sent to their Aadhaar-linked mobile number by UIDAI, to access a downloadable XML file with their Aadhaar details in a share code manner.    
                              **Realtime face match** for liveness detection: The Aadhaar Offline document has Name, Address, Photo, Gender, DOB. Optionally, the photo in the UIDAI Issued Aadhaar document can be matched with customers' live photo or a selfie in real time to ensure liveness checks.   

      *You can simply integrate Offline Aadhaar eKYC within your application
      with no-code and in no time with our Deepvue.tech Offline Aadhaar eKYC
      SDKs.*    


      **Below are the integration guides to integrate the platform specific
      SDKs:**   

      **Android SDK** :
      https://github.com/deepvue-tech/deepvue-aadhaar-offline-ekyc-android-sdk   
                              **iOS SDK** : https://github.com/deepvue-tech/deepvue-aadhaar-offline-ekyc-ios-sdk   
                              **React-Native SDK** : https://github.com/deepvue-tech/deepvue-aadhaar-offline-ekyc-react-sdk    
                              **Flutter SDK** : https://pub.dev/packages/aadhaar_offline_ekyc    

      **NOTE**:   
                  
              As per the compliances by UIDAI on sharing and storage of Aadhaar number is not allowed.    
              
              Service Providers shall not share, publish or display either Share Code or XML file or its contents with anyone else.   
              Any non-compliance of these actions shall invite actions under Sections 17 and 25 of The Aadhaar (Authentication) Regulation, 2016,    
              Sections 4 and 6 of The Aadhaar (Sharing of Information) Regulation, 2016 and Sections 29(2), 29 (3), and 37 of The Aadhaar Act, 2016.   

              Consent should be mandatorily stored at the company end to proceed with verification.   

      If you want to integrate Aadhaar eKYC in your web application or want to
      build your own customized workflow you can use our Aadhaar eKYC APIs
      detailed below.   


      Embed offline eKYC Aadhaar flow to verify consumers on your application
      using a simple flow.    
                                      - **Initiate Session**: This API allows the platform to initiate a session to get the captcha before passing the Aadhaar number of the customer.    
                                      - **Generate OTP**: This API allows the platform to pass the Aadhaar number to generate OTP to the linked mobile number.    
                                      - **Verify OTP**: This API allows the platform to pass the OTP to Deepvue.tech to fetch the customer's Aadhaar information from UIDAI.    

      If the customer or the platform wishes to restart the session, a new
      captcha can be generated using the Reload Captcha API.
  - name: Digilocker
    description: >-
      Digilocker is an initiative under Digital India Program which aims to
      remove the dependency on physical documents and power the sharing of
      verified electronic documents across authorised agencies.   


      **Benefits of Digilocker**    
                              1. Documents can be shared online, accessed anytime, anywhere.   
                              2. Documents can be authenticated by the users, legally on a par with originals.   
                              3. It's simple to use and very convenient.   
                              4. Documents are issued directly by the registered issuers such as Income Tax Department, CBSE, Registrar Office, etc.    

      **Product Flow**   

      **Initiate Session** : This API creates a session in which DigiLocker
      journey can be completed with other APIs in the flow.   
                              **Get User Access Token** : This API allows the platform to get user access token from Digilocker by passing the authorisation code generated from Digilocker.   
                              **Get Issued Files** : This API allows the platform to fetch a list of issued documents from Digilocker.    
                              **Download e-Aadhar** : This API allows the platform to download the Aadhaar XML from Digilocker.    
                              **Download File** : This API allows the platform to download the file from Digilocker by passing the URI for a particular document.    
  - name: KYC APIs
    description: >-
      Verify Aadhaar, PAN, GSTIN, Bank Account, and UPI details in real time for
      quick KYC checks.
  - name: Document OCR
    description: >-
      Our systems use Modern & Latest OCR technology to scan the document images
      for field’s like full name, dob, address, etc. on the photo IDs and
      exctract these fields as key-value pairs.
  - name: Document Forensics
    description: >-
      Set of APIs that help with document forensic checks like template
      validation, image quality, photocopy, and spoof checks.
  - name: Face Forensics
    description: >-
      APIs for facial recognition and liveliness verification in real time.    

      The Face Match API employs advanced algorithms for reliable facial
      matching, crucial for secure access control and compliance.   

      The Passive Liveness API enhances security by detecting and confirming the
      liveliness of faces during authentication, providing an additional layer
      of protection against impersonation and fraud.   
  - name: Async KYC APIs
    description: >-
      Verify other Identity documents such as Driving License, Vehicle
      Registration Certificate etc. in real time for fast KYC checks.    
              These are Asynchronous APIs which return a request ID and use a webhook mechanism to return the response back to your servers.    
              You can then use this request ID and feed this into our GET API to consume the response.
  - name: GST APIs
    description: >-
      Set of APIs that help with GST Registered business verification and
      onboarding.
  - name: GST Taxpayer APIs
    description: >-
      The GST Taxpayer APIs are provided by the GSTN for public usage. These
      APIs, together, mirror the GST Portal.   


      Therefore, you can use these APIs to integrate GST compliance into your
      workflow itself.   


      Use the following workflow to access the GST Taxpayer APIs:   


      **First**, the GST taxpayer is authenticated using **OTP
      Verification**.   


      **Second**, after successful authentication, the GST Taxpayer APIs can be
      accessed.   
         i. **Ledger APIs** - Fetch the taxpayer's ledger like a) Cash ITC Balance, b) Cash Ledger, c) ITC Ledger.   
         ii. **Returns APIs** - Fetch the taxpayer's detailed summaries of GSTR -1 and GSTR -3B Returns.   
  - name: Taxpayer APIs
    description: |-
      Taxpayer APIs includes TAN Verification.   

       Taxpayer APIs help businesses verify their vendors, customers & employees using TAN. APIs also provide publicly available data such as name, address, and contact details that can be verified against physical documents.   
  - name: ITR APIs
    description: |-
      ITR APIs includes ITR Verification APIs including 26AS.   

       ITR APIs helps businesses download ITR information, such as ITR ID, Filing Year, Acknowledgement Number, ITR Form, Filing Date, ITR status, etc..    
  - name: MSME APIs
    description: >-
      Set of APIs that help with MSME Registered business verification and
      onboarding.
  - name: MCA APIs
    description: >-
      Set of APIs that help fetch MCA's Director Master Data & Company Master
      Data.
  - name: Financial Services
    description: >-
      Suite that provides you whole array of APIs to serve multiple financial
      services and fetch data for an organisation or individual from various
      data sources in a streamlined manner.   


      Some of the key things that you can do here are:   


      i.Fetch the Credit Report from any of our partner credit bureaus.   

      ii.Fetch customer's Customer Data Pull basis mobile number and name to
      simplify your onboarding.
  - name: Account Aggregator
    description: >-
      Account Aggregators(AAs) are regulated entities that facilitate consented
      sharing of financial data by utilising the DEPA framework. They act as the
      bridge between data providers such as banks, and data consumers such as
      lenders—to enable the sharing of a user’s financial data based on their
      explicit consent.   
              Deepvue currently provides AA-related services in close partnership with a fully-licensed AA.
paths:
  /v1/verification/gstin-advanced:
    get:
      tags:
        - GST APIs
      summary: Gstin Advanced Verification
      description: >-
        This API takes in the gstin of a business entity and provides you the
        information of the business entities as registered on the GST Portal.


        Verifies basic GSTIN Details alongside advanced ones such as point of
        contact email & mobile, annual turnover and filing status and many
        more...
      operationId: GSTIN_Advanced_Verification_v1_verification_gstin_advanced_get
      parameters:
        - required: true
          schema:
            title: Gstin Number
            type: string
            description: >-
              This query parameter is used to provide the GST Identification
              Number for advanced GSTIN verification.
          name: gstin_number
          in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESPONSE_GST_ADVANCED_200_SUCCESSFUL'
              examples:
                200 - GSTIN Verification Successful:
                  value:
                    code: 200
                    timestamp: 1737862347191
                    transaction_id: 9f808ad40a1b49b6bb1839921248c37a
                    sub_code: SUCCESS
                    message: GSTIN Verified Successfully.
                    data:
                      contact_details:
                        principal:
                          address: >-
                            Belur Industrial Area, Works Office, Mummigatti
                            Post, Pune Bangalore Road, Dharwad, Dharwad,
                            Karnataka, 580011
                          email: gst.south@tatamotors.com
                          mobile: '9130094259'
                          nature_of_business: >-
                            Factory / Manufacturing, Office / Sale Office,
                            Recipient of Goods or Services, Service Provision,
                            Wholesale Business, Retail Business
                        additional:
                          - address: >-
                              BELUR INDUSTRIAL AREA, TMML, GARAG ROAD,
                              MUMMIGATTI POSTT DHARWAD, Dharwad, Karnataka,
                              580011
                            email: gst.south@tatamotors.com
                            mobile: '9130094259'
                            nature_of_business: Others
                          - address: >-
                              Kailash Vahan Udyog Limited Factory 21,
                              Balagaranahalli Hosur main road, Attibele,
                              Bengaluru Rural, Karnataka, 562107
                            email: gst.south@tatamotors.com
                            mobile: '9130094259'
                            nature_of_business: Others
                          - address: >-
                              Warehouse, Survey No 331 and A/332, Marsur
                              Village, Kasab Hobli, Anekal Taluk, Bengaluru
                              Urban, Karnataka, 560081
                            email: gst.south@tatamotors.com
                            mobile: '9130094259'
                            nature_of_business: Others
                          - address: >-
                              Plot No 317-P, 318-P, 319-P, Jigani-Bommasandra
                              link Road, Jigani, Anekal Taluk, Bengaluru Urban,
                              Karnataka, 562106
                            email: gst.south@tatamotors.com
                            mobile: '9130094259'
                            nature_of_business: Others
                          - address: >-
                              Vehicle Maintenance Department, VRL Complex, 16KM
                              Bangalore Road, NH4, Hubballi, Warur, Dharwad,
                              Karnataka, 581207
                            email: gst.south@tatamotors.com
                            mobile: '9130094259'
                            nature_of_business: Warehouse / Depot
                          - address: >-
                              Krishnapuram Jigani, Plot No 314 and 319, Tata
                              Motors Ltd SPD CV, Anekal Taluk Jigani,
                              Jigani-Bommasandra link Road, Sidlaghatta,
                              Chikkaballapur, Karnataka, 562105
                            email: gst.south@tatamotors.com
                            mobile: '9130094259'
                            nature_of_business: >-
                              Export, Recipient of Goods or Services, Warehouse
                              / Depot, Office / Sale Office
                          - address: >-
                              Mummigatti Post, Regional Sales Office, NH 4, Tata
                              Motors Manufacturing Plant Dharwad, Belur
                              Industrial Area, Belur Industrial Area, Dharwad,
                              Karnataka, 580011
                            email: gst.south@tatamotors.com
                            mobile: '9130094259'
                            nature_of_business: >-
                              Bonded Warehouse, Recipient of Goods or Services,
                              Warehouse / Depot, Office / Sale Office, Export
                          - address: >-
                              No 129/1B, IMAC India Coach Builders Pvt Ltd,
                              Mysore Road, Kengeri, Bengaluru, Bengaluru Urban,
                              Karnataka, 560060
                            email: gst.south@tatamotors.com
                            mobile: '9130094259'
                            nature_of_business: >-
                              Others, Supplier of Services, Recipient of Goods
                              or Services, Office / Sale Office
                          - address: >-
                              2 and 3 Floor, # 648, Regional Area Office, 1st
                              Main Road. Sector 6 HSR Layout, Bengaluru,
                              Bengaluru Urban, Karnataka, 560102
                            email: gst.south@tatamotors.com
                            mobile: '9130094259'
                            nature_of_business: >-
                              Office / Sale Office, Supplier of Services,
                              Recipient of Goods or Services
                          - address: >-
                              127, Tata Motors Limited -SATRAC ENGINEERING,
                              SOMPURA INDUSTRIAL AREA, Nidavanda Village,
                              Dobaspet Industrial Area, Bengaluru Rural,
                              Karnataka, 562132
                            email: gst.south@tatamotors.com
                            mobile: '9130094259'
                            nature_of_business: >-
                              Office / Sale Office, Others, Recipient of Goods
                              or Services, Supplier of Services, Warehouse /
                              Depot
                          - address: >-
                              1A, 1st Floor, Roopena Agrahara., Fortune
                              Summit,Sector 6 , under BBMP Ward No.174.,
                              290/281/276/243/244, Hosur Road, Bommanahalli,
                              Bengaluru, Bengaluru Urban, Karnataka, 560068
                            email: gst.south@tatamotors.com
                            mobile: '9130094259'
                            nature_of_business: >-
                              Bonded Warehouse, Retail Business, Supplier of
                              Services, Recipient of Goods or Services,
                              Warehouse / Depot, Office / Sale Office
                          - address: >-
                              Plot No. 176 C, SY No. 233 and 241, Anchemco India
                              Pvt Ltd, Belur village, Dharwad Taluk, Garag
                              Hobli, Belur Industrial Area, Dharwad, Dharwad,
                              Karnataka, 580001
                            email: gst.south@tatamotors.com
                            mobile: '9130094259'
                            nature_of_business: >-
                              Bonded Warehouse, Warehouse / Depot, Office / Sale
                              Office, Others, Export, Supplier of Services,
                              Recipient of Goods or Services
                      promoters:
                        - 'Girish Arun Wagh '
                        - 'Om Prakash Bhatt '
                      annual_turnover: 'Slab: Rs. 500 Cr. and above'
                      annual_turnover_fy: 2023-2024
                      percentage_in_cash_fy: 2023-2024
                      percentage_in_cash: 'Slab: 2 to 5%'
                      aadhaar_validation: 'Yes'
                      aadhaar_validation_date: '2024-12-06'
                      address_details: {}
                      gstin: 29AAACT2727Q1ZS
                      pan_number: AAACT2727Q
                      business_name: TATA  MOTORS  LTD
                      legal_name: TATA MOTORS LIMITED
                      center_jurisdiction: >-
                        State - CBIC,Zone - BENGALURU,Commissionerate -
                        BELAGAVI,Division - DHARWAR DIVISION,Range - DHARWAD-B
                        RANGE (Jurisdictional Office)
                      state_jurisdiction: >-
                        State - Karnataka,Division - DGSTO Dharwad, LOCAL GST
                        Office - LGSTO 310 - Dharwad
                      date_of_registration: '2017-07-01'
                      constitution_of_business: Public Limited Company
                      taxpayer_type: Regular
                      gstin_status: Active
                      date_of_cancellation: '1800-01-01'
                      field_visit_conducted: 'No'
                      nature_bus_activities:
                        - Factory / Manufacturing
                        - Office / Sale Office
                        - Recipient of Goods or Services
                        - Service Provision
                        - Wholesale Business
                        - Retail Business
                        - Others
                        - Warehouse / Depot
                        - Export
                        - Bonded Warehouse
                        - Supplier of Services
                      nature_of_core_business_activity_code: MFT
                      nature_of_core_business_activity_description: Manufacturer
                      filing_status:
                        - - return_type: GSTR1
                            financial_year: 2024-2025
                            tax_period: December
                            date_of_filing: '2025-01-11'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR1
                            financial_year: 2024-2025
                            tax_period: November
                            date_of_filing: '2024-12-10'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR1
                            financial_year: 2024-2025
                            tax_period: October
                            date_of_filing: '2024-11-11'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR1
                            financial_year: 2024-2025
                            tax_period: September
                            date_of_filing: '2024-10-11'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR1
                            financial_year: 2024-2025
                            tax_period: August
                            date_of_filing: '2024-09-11'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR1
                            financial_year: 2024-2025
                            tax_period: July
                            date_of_filing: '2024-08-09'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR1
                            financial_year: 2024-2025
                            tax_period: June
                            date_of_filing: '2024-07-10'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR1
                            financial_year: 2024-2025
                            tax_period: May
                            date_of_filing: '2024-06-10'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR1
                            financial_year: 2024-2025
                            tax_period: April
                            date_of_filing: '2024-05-10'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR1
                            financial_year: 2023-2024
                            tax_period: March
                            date_of_filing: '2024-04-11'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR3B
                            financial_year: 2024-2025
                            tax_period: December
                            date_of_filing: '2025-01-22'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR3B
                            financial_year: 2024-2025
                            tax_period: November
                            date_of_filing: '2024-12-20'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR3B
                            financial_year: 2024-2025
                            tax_period: October
                            date_of_filing: '2024-11-20'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR3B
                            financial_year: 2024-2025
                            tax_period: September
                            date_of_filing: '2024-10-19'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR3B
                            financial_year: 2024-2025
                            tax_period: August
                            date_of_filing: '2024-09-20'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR3B
                            financial_year: 2024-2025
                            tax_period: July
                            date_of_filing: '2024-08-20'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR3B
                            financial_year: 2024-2025
                            tax_period: June
                            date_of_filing: '2024-07-20'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR3B
                            financial_year: 2024-2025
                            tax_period: May
                            date_of_filing: '2024-06-20'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR3B
                            financial_year: 2024-2025
                            tax_period: April
                            date_of_filing: '2024-05-20'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR3B
                            financial_year: 2023-2024
                            tax_period: March
                            date_of_filing: '2024-04-20'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR9
                            financial_year: 2023-2024
                            tax_period: Annual
                            date_of_filing: '2024-12-26'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR9
                            financial_year: 2022-2023
                            tax_period: Annual
                            date_of_filing: '2023-12-22'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR9
                            financial_year: 2021-2022
                            tax_period: Annual
                            date_of_filing: '2022-12-19'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR9
                            financial_year: 2020-2021
                            tax_period: Annual
                            date_of_filing: '2021-11-11'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR9
                            financial_year: 2019-2020
                            tax_period: Annual
                            date_of_filing: '2021-02-24'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR9
                            financial_year: 2018-2019
                            tax_period: Annual
                            date_of_filing: '2020-09-21'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR9
                            financial_year: 2017-2018
                            tax_period: Annual
                            date_of_filing: '2019-09-26'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR9C
                            financial_year: 2023-2024
                            tax_period: Annual
                            date_of_filing: '2024-12-26'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR9C
                            financial_year: 2022-2023
                            tax_period: Annual
                            date_of_filing: '2023-12-23'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR9C
                            financial_year: 2021-2022
                            tax_period: Annual
                            date_of_filing: '2022-12-21'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR9C
                            financial_year: 2020-2021
                            tax_period: Annual
                            date_of_filing: '2021-11-11'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR9C
                            financial_year: 2019-2020
                            tax_period: Annual
                            date_of_filing: '2021-02-25'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR9C
                            financial_year: 2018-2019
                            tax_period: Annual
                            date_of_filing: '2020-09-24'
                            status: Filed
                            mode_of_filing: ONLINE
                          - return_type: GSTR9C
                            financial_year: 2017-2018
                            tax_period: Annual
                            date_of_filing: '2019-10-22'
                            status: Filed
                            mode_of_filing: ONLINE
                      address: null
                      hsn_info: {}
                      filing_frequency: []
        '400':
          description: BAD_REQUEST (Invalid Input / Parameters)
          content:
            application/json:
              schema:
                title: Response 400 - Inactive Client / Bad Request
                oneOf:
                  - $ref: >-
                      #/components/schemas/RESPONSE_GST_ADVANCED_400_INACTIVE_CLIENT
                  - $ref: '#/components/schemas/RESPONSE_GST_ADVANCED_400_BAD_REQUEST'
              examples:
                400 - Inactive Client:
                  summary: Inactive client
                  value:
                    detail: Inactive client_id
                400 - Bad Request:
                  summary: Bad request
                  value:
                    detail: Bad Request
        '401':
          description: Incorrect client_id or client_secret
          content:
            application/json:
              schema:
                title: >-
                  Response 401 - Unauthenticated / Invalid Client / Invalid
                  Credentials / Authorization Failure
                oneOf:
                  - $ref: >-
                      #/components/schemas/RESPONSE_GST_ADVANCED_401_UNAUTHENTICATED
                  - $ref: >-
                      #/components/schemas/RESPONSE_GST_ADVANCED_401_INVALID_CLIENT
                  - $ref: >-
                      #/components/schemas/RESPONSE_GST_ADVANCED_401_INVALID_CREDENTIALS
                  - $ref: >-
                      #/components/schemas/RESPONSE_GST_ADVANCED_401_AUTHORIZATION_FAILURE
              examples:
                401 - Not Authenticated:
                  summary: Not authenticated
                  value:
                    detail: Not authenticated
                401 - Invalid Client:
                  summary: Invalid client
                  value:
                    detail: Invalid client_id
                401 - Invalid Credentials:
                  summary: Invalid credentials
                  value:
                    detail: Could not validate credentials
                401 - Authorization Failure:
                  summary: Authorization failure
                  value:
                    detail: Authorization failure
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                title: Response 403 - Token Expired / Access Forbidden
                oneOf:
                  - $ref: >-
                      #/components/schemas/RESPONSE_GST_ADVANCED_403_TOKEN_EXPIRED
                  - $ref: >-
                      #/components/schemas/RESPONSE_GST_ADVANCED_403_ACCESS_FORBIDDEN
              examples:
                403 - Token Expired:
                  summary: Token expired
                  value:
                    detail: Not a valid token
                403 - Access Forbidden:
                  summary: Access forbidden
                  value:
                    detail: Access forbidden
        '422':
          description: BAD_REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESPONSE_GST_ADVANCED_422_INVALID_PATTERN'
              examples:
                422 - Invalid GSTIN Pattern:
                  summary: Invalid GSTIN pattern
                  value:
                    code: 422
                    timestamp: 1738052019250
                    transaction_id: 4bb474ac-863b-4884-8a7f-b481a087047a
                    message: Invalid GSTIN pattern
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/RESPONSE_GST_ADVANCED_500_INTERNAL_SERVER_ERROR
              examples:
                500 - Internal Server Error:
                  summary: Internal server error
                  value:
                    detail: Internal Server Error
components:
  schemas:
    RESPONSE_GST_ADVANCED_200_SUCCESSFUL:
      title: GSTIN Advanced Verified
      type: object
      properties:
        code:
          title: Code
          type: integer
          default: 200
        timestamp:
          title: Timestamp
          type: integer
        transaction_id:
          title: Transaction Id
          type: string
        sub_code:
          title: Sub Code
          type: string
          default: SUCCESS
        message:
          title: Message
          type: string
          default: GSTIN Verified Successfully.
        data:
          title: Data
          type: object
          properties:
            contact_details:
              title: Contact Details
              type: object
              properties:
                principal:
                  title: Principal
                  type: object
                  properties:
                    address:
                      title: Address
                      type: string
                    email:
                      title: Email
                      type: string
                    mobile:
                      title: Mobile
                      type: string
                    nature_of_business:
                      title: Nature Of Business
                      type: string
                additional:
                  title: Additional
                  type: array
                  items:
                    type: object
                    properties:
                      address:
                        title: Address
                        type: string
                      email:
                        title: Email
                        type: string
                      mobile:
                        title: Mobile
                        type: string
                      nature_of_business:
                        title: Nature Of Business
                        type: string
            promoters:
              title: Promoters
              type: array
              items:
                type: string
            annual_turnover:
              title: Annual Turnover
              type: string
            annual_turnover_fy:
              title: Annual Turnover FY
              type: string
            percentage_in_cash_fy:
              title: Percentage In Cash FY
              type: string
            percentage_in_cash:
              title: Percentage In Cash
              type: string
            aadhaar_validation:
              title: Aadhaar Validation
              type: string
            aadhaar_validation_date:
              title: Aadhaar Validation Date
              type: string
            address_details:
              title: Address Details
              type: object
            gstin:
              title: GSTIN
              type: string
            pan_number:
              title: Pan Number
              type: string
            business_name:
              title: Business Name
              type: string
            legal_name:
              title: Legal Name
              type: string
            center_jurisdiction:
              title: Center Jurisdiction
              type: string
            state_jurisdiction:
              title: State Jurisdiction
              type: string
            date_of_registration:
              title: Date Of Registration
              type: string
            constitution_of_business:
              title: Constitution Of Business
              type: string
            taxpayer_type:
              title: Taxpayer Type
              type: string
            gstin_status:
              title: GSTIN Status
              type: string
            date_of_cancellation:
              title: Date Of Cancellation
              type: string
            field_visit_conducted:
              title: Field Visit Conducted
              type: string
            nature_bus_activities:
              title: Nature Of Business Activities
              type: array
              items:
                type: string
            nature_of_core_business_activity_code:
              title: Nature Of Core Business Activity Code
              type: string
            nature_of_core_business_activity_description:
              title: Nature Of Core Business Activity Description
              type: string
            filing_status:
              title: Filing Status
              type: array
              items:
                type: array
                items:
                  type: object
                  properties:
                    return_type:
                      title: Return Type
                      type: string
                    financial_year:
                      title: Financial Year
                      type: string
                    tax_period:
                      title: Tax Period
                      type: string
                    date_of_filing:
                      title: Date Of Filing
                      type: string
                    status:
                      title: Status
                      type: string
                    mode_of_filing:
                      title: Mode Of Filing
                      type: string
            address:
              title: Address
              type: string
              nullable: true
            hsn_info:
              title: HSN Info
              type: object
            filing_frequency:
              title: Filing Frequency
              type: array
              items:
                type: string
    RESPONSE_GST_ADVANCED_400_INACTIVE_CLIENT:
      title: Inactive Client
      type: object
      properties:
        detail:
          title: Detail
          type: string
          default: Inactive client_id
    RESPONSE_GST_ADVANCED_400_BAD_REQUEST:
      title: Bad Request
      type: object
      properties:
        detail:
          title: Detail
          type: string
          default: Bad Request
    RESPONSE_GST_ADVANCED_401_UNAUTHENTICATED:
      title: Not Authenticated
      type: object
      properties:
        detail:
          title: Detail
          type: string
          default: Not authenticated
    RESPONSE_GST_ADVANCED_401_INVALID_CLIENT:
      title: Invalid Client
      type: object
      properties:
        detail:
          title: Detail
          type: string
          default: Invalid client_id
    RESPONSE_GST_ADVANCED_401_INVALID_CREDENTIALS:
      title: Invalid Credentials
      type: object
      properties:
        detail:
          title: Detail
          type: string
          default: Could not validate credentials
    RESPONSE_GST_ADVANCED_401_AUTHORIZATION_FAILURE:
      title: Authorization Failure
      type: object
      properties:
        detail:
          title: Detail
          type: string
          default: Authorization failure
    RESPONSE_GST_ADVANCED_403_TOKEN_EXPIRED:
      title: Token Expired
      type: object
      properties:
        detail:
          title: Detail
          type: string
          default: Not a valid token
    RESPONSE_GST_ADVANCED_403_ACCESS_FORBIDDEN:
      title: Access Forbidden
      type: object
      properties:
        detail:
          title: Detail
          type: string
          default: Access forbidden
    RESPONSE_GST_ADVANCED_422_INVALID_PATTERN:
      title: Invalid GSTIN Pattern
      type: object
      properties:
        code:
          title: Code
          type: integer
          default: 422
        timestamp:
          title: Timestamp
          type: integer
        transaction_id:
          title: Transaction Id
          type: string
        message:
          title: Message
          type: string
          default: Invalid GSTIN pattern
    RESPONSE_GST_ADVANCED_500_INTERNAL_SERVER_ERROR:
      title: Internal Server Error
      type: object
      properties:
        detail:
          title: Detail
          type: string
          default: Internal Server Error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        ACCESS_TOKEN generated from the authorize endpoint. Should be included
        in the header as Bearer .
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        The CLIENT_SECRET provided to you. This header parameter is required for
        authentication purposes.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.