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

# PAN-GST Link

> Check if a PAN number is linked to any GST registrations

## Overview

Verify if a PAN number is associated with GST registrations and retrieve all linked GSTIN details including status and state information.


## OpenAPI

````yaml POST /v2/verification/pan-gst-link/
openapi: 3.0.0
info:
  title: KonnectNXT API Store
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://bgv.konnectnxt.com/api
    description: Production
  - url: https://testbgv.konnectnxt.com/api
    description: QA
security:
  - bearerAuth: []
paths:
  /v2/verification/pan-gst-link/:
    post:
      tags:
        - Business Verification
      summary: PAN-GST Link Verification
      description: >-
        Verifies if a PAN number is linked to any GST registrations and returns
        all associated GSTIN details.
      operationId: verifyPanGstLink
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PanGstLinkRequest'
            examples:
              Example:
                summary: PAN-GST link verification
                value:
                  pan_number: AABCI6363G
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/APIBaseResponse'
                  - $ref: '#/components/schemas/Credits'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/PanGstLinkData'
              examples:
                Success:
                  summary: Successful verification with GST registrations found
                  value:
                    status: success
                    code: 200
                    message: Operation completed successfully
                    data:
                      gst_associated_with_pan: true
                      gst_registrations:
                        - gstin: 27AABCI6363G1ZJ
                          status: ACTIVE
                          state: Maharashtra
                    credits_used: 10
                    credits_remaining: 984096.5
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '403':
          $ref: '#/components/responses/403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIBaseResponse'
              examples:
                NotFound:
                  summary: No GST registrations found
                  value:
                    status: error
                    code: 404
                    message: No GST registrations found for the provided PAN
                    data: null
        '500':
          $ref: '#/components/responses/500'
components:
  schemas:
    PanGstLinkRequest:
      type: object
      required:
        - pan_number
      properties:
        pan_number:
          type: string
          description: PAN number to check for GST linkage
          pattern: ^[A-Z]{5}[0-9]{4}[A-Z]$
          minLength: 10
          maxLength: 10
          example: AABCI6363G
    APIBaseResponse:
      type: object
      required:
        - status
        - code
        - message
      properties:
        status:
          $ref: '#/components/schemas/APIStatus'
        code:
          $ref: '#/components/schemas/HTTPCode'
        message:
          $ref: '#/components/schemas/APIMessage'
    Credits:
      type: object
      properties:
        credits_used:
          $ref: '#/components/schemas/CreditsUsed'
        credits_left:
          $ref: '#/components/schemas/CreditsLeft'
      required:
        - credits_used
        - credits_left
    PanGstLinkData:
      type: object
      required:
        - gst_associated_with_pan
      properties:
        gst_associated_with_pan:
          type: boolean
          description: Indicates whether the PAN is linked to any GST registrations
        gst_registrations:
          type: array
          description: List of GST registrations linked to the PAN
          items:
            $ref: '#/components/schemas/GSTRegistration'
    APIStatus:
      type: string
      enum:
        - success
        - error
      description: Overall status of the API
    HTTPCode:
      type: integer
      description: HTTP status code
      example: 400
    APIMessage:
      type: string
      description: Description of the response or error
      example: Invalid request parameters
    CreditsUsed:
      type: integer
      description: Represents the total number of credits used in this request.
      example: 3
    CreditsLeft:
      type: integer
      description: 'Represents the remaining credits available for use. '
      example: 4040
    GSTRegistration:
      type: object
      required:
        - gstin
        - status
        - state
      properties:
        gstin:
          type: string
          description: GST Identification Number
          example: 27AABCI6363G1ZJ
        status:
          type: string
          description: Current status of the GST registration
          enum:
            - ACTIVE
            - INACTIVE
            - SUSPENDED
            - CANCELLED
          example: ACTIVE
        state:
          type: string
          description: State where the GST is registered
          example: Telangana
    Error:
      allOf:
        - $ref: '#/components/schemas/APIBaseResponse'
    APIErrorData:
      type: object
      properties:
        data:
          type: object
          nullable: true
          example: null
  responses:
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - $ref: '#/components/schemas/APIErrorData'
    '401':
      description: Unauthorized
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - $ref: '#/components/schemas/APIErrorData'
          examples:
            Missing Token:
              summary: Bearer token is missing or invalid.
              value:
                status: error
                code: 401
                message: Bearer token is missing or invalid.
                data: null
            Incorrect Token Format:
              summary: Token format is incorrect
              value:
                status: error
                code: 401
                message: Token format is incorrect
                data: null
            No Admin Found:
              summary: No admin found for this request
              value:
                status: error
                code: 401
                message: No admin user found for this organization
                data: null
            Invalid API Key:
              summary: Invalid API Key
              value:
                status: error
                code: 401
                message: Invalid API key (organization ID)
                data: null
            User not Found:
              summary: User not found
              value:
                status: error
                code: 401
                message: User not found.
                data: null
    '402':
      description: Payment Required
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - $ref: '#/components/schemas/APIErrorData'
          examples:
            Credit Limit Exceed:
              summary: Credit Limit Exceeded.
              value:
                status: error
                code: 402
                message: Credit Limit Exceeded.
                data: null
            Insufficient Credits:
              summary: Insufficient credits
              value:
                status: error
                code: 402
                message: 'Insufficient credits: 2 required, 1 remaining.'
                data: null
    '403':
      description: Forbidden
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - $ref: '#/components/schemas/APIErrorData'
          examples:
            Token Revoked:
              summary: Token access has been Revoked, Contact Support.
              value:
                status: error
                code: 403
                message: Token access has been Revoked, Contact Support.
                data: null
            Token Inactive:
              summary: Token is Inactive, Contact Support.
              value:
                status: error
                code: 403
                message: Token is Inactive, Contact Support.
                data: null
    '500':
      description: Internal Server Error
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - $ref: '#/components/schemas/APIErrorData'
          examples:
            Internal Server Error:
              summary: Internal Server Error.
              value:
                status: error
                code: 500
                message: Internal Server Error.
                data: null
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key issued by KonnectNXT. Pass as `Authorization: Bearer
        <your_api_key>`.

````