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

# Business flow

> Check a company's profile, its PAN, what is registered under that PAN, and its bank account.



## OpenAPI

````yaml /suite/api-reference/openapi.json post /bundle/v1/business
openapi: 3.1.0
info:
  title: Privue API Suite
  version: 1.0.0
  description: >-
    Business, tax, registry, employment and identity verification against
    official Indian sources, a person's own documents read through DigiLocker
    with their consent, and an EPF member's passbook read with the OTP they
    receive.


    **Authentication.** Every request takes your API key as a bearer token:
    `Authorization: Bearer <your-key>`.


    **One envelope.** Every check returns the reasons behind a refusal and the
    record the source held, and an empty `reasons` means the check passed.
    Branch on `reasons` rather than on the status code, because a call the
    source answered returns `200` whatever it concluded.


    **DigiLocker and EPFO passbook.** A DigiLocker endpoint returns `details`
    alone: what it read, as the source holds it. So do submitting an EPFO
    passbook OTP and reading the passbook; sending the OTP answers like a check.


    **Versioning.** Each endpoint is versioned on its own, directly in its path.
    A new version of one endpoint never moves another, so no release requires
    migrating every integration at once.
servers:
  - url: https://api.privue.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Checks
    description: One check on one subject, answered in the envelope every check shares.
  - name: DigiLocker
    description: >-
      A person's own documents, read through the consent they give at
      DigiLocker.
  - name: EPFO passbook
    description: >-
      A member's EPF passbook, read with the OTP sent to the mobile number on
      their account.
  - name: Orchestrated flows
    description: Every check on one business, asked and answered together in a single call.
  - name: Usage
    description: What you have called, and when.
paths:
  /bundle/v1/business:
    post:
      tags:
        - Orchestrated flows
      summary: Business flow
      description: >-
        Check a company's profile, its PAN, what is registered under that PAN,
        and its bank account.
      operationId: bundle.business
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessBundleRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessBundleResponse'
              examples:
                verified:
                  summary: Every check passed
                  value:
                    bundle: business
                    credits_charged: 21
                    results:
                      company:
                        reasons: []
                        details:
                          cin: U74999MH2015PTC123456
                          company_name: EXAMPLE TECHNOLOGIES PRIVATE LIMITED
                          registration_number: '123456'
                          pan: null
                          class: PRIVATE
                          category: COMPANY LIMITED BY SHARES
                          sub_category: NON-GOVERNMENT COMPANY
                          company_type: INDIAN COMPANY
                          country_of_incorporation: INDIAN
                          date_of_incorporation: '2015-04-01'
                          status: ACTIVE
                          status_for_efiling: ACTIVE
                          status_under_cirp: null
                          active_compliance: null
                          whether_listed: UNLISTED
                          suspended_at_stock_exchange: null
                          authorised_capital: 1000000
                          paid_up_capital: 500000
                          total_obligation_of_contribution: 0
                          number_of_members: null
                          last_agm_date: '2025-09-27'
                          balance_sheet_date: '2025-03-31'
                          roc_office: ROC MUMBAI
                          nature_of_business: null
                          description_of_main_division: null
                          registered_address: >-
                            UNIT 402, 4TH FLOOR, TECH PARK, ANDHERI KURLA ROAD,
                            ANDHERI EAST, MUMBAI, MAHARASHTRA, 400093
                          address_other_than_registered_office: null
                          registered_address_split:
                            full_address: >-
                              UNIT 402, 4TH FLOOR, TECH PARK, ANDHERI KURLA
                              ROAD, ANDHERI EAST, MUMBAI, MAHARASHTRA, 400093
                            address_line1: UNIT 402, 4TH FLOOR, TECH PARK,
                            address_line2: ANDHERI KURLA ROAD, ANDHERI EAST
                            city: MUMBAI
                            state: MAHARASHTRA
                            pincode: '400093'
                          email_id: compliance@example.com
                          no_of_directors: 2
                          directorDetails:
                            - din: '01234567'
                              name: RAHUL MEHTA
                              designation: DIRECTOR
                              date_of_appointment: '2015-04-01'
                              dob: '1984-06-18'
                              nationality: INDIAN
                              citizen_of_india: true
                              resident_of_india: true
                              other_directorships:
                                listOfCompanies:
                                  - cin: U63090MH2018PTC309876
                                    company_name: EXAMPLE LOGISTICS PRIVATE LIMITED
                                    begin_date: '2018-07-02'
                                    end_date: null
                                listOfLLPs: []
                            - din: '07654321'
                              name: PRIYA NAIR
                              designation: DIRECTOR
                              date_of_appointment: '2019-11-15'
                              dob: '1988-02-09'
                              nationality: INDIAN
                              citizen_of_india: true
                              resident_of_india: true
                              other_directorships:
                                listOfCompanies: []
                                listOfLLPs: []
                      pan:
                        reasons: []
                        details:
                          pan: AAACE1234F
                          category: Company
                          status: valid
                          remarks: null
                          name_as_per_pan_match: true
                          date_of_birth_match: true
                          aadhaar_seeded: null
                      gst:
                        reasons: []
                        details:
                          gstin: 27AAACE1234F1Z6
                          legal_name: EXAMPLE TECHNOLOGIES PRIVATE LIMITED
                          trade_name: EXAMPLE TECH
                          registration_date: '2017-07-01'
                          cancellation_date: null
                          registration_status: Active
                          jurisdiction:
                            state: >-
                              STATE - MAHARASHTRA,ZONE - MUMBAI,DIVISION -
                              EAST,CHARGE - ANDHERI_EAST_701
                            central: >-
                              STATE - CBIC,ZONE - MUMBAI,COMMISSIONERATE -
                              MUMBAI EAST,DIVISION - DIVISION IV
                          primary_business_address:
                            street: >-
                              UNIT 402, 4TH FLOOR, TECH PARK, ANDHERI KURLA
                              ROAD, ANDHERI EAST
                            city: MUMBAI
                            state: Maharashtra
                            country: India
                            postal_code: '400093'
                          other_business_address: null
                          business_constitution: Private Limited Company
                          business_nature:
                            - Supplier of Services
                            - Office / Sale Office
                          taxpayer_type: Regular
                          e_invoice_mandated: true
                      udyam:
                        reasons: []
                        details:
                          pan: AAACE1234F
                          enterprise_data:
                            udyam_reg_no: UDYAM-MH-19-0012345
                            major_activity: Services
                            enterprise_type: Small
                            organization_type: Private Limited Company
                            official_name: EXAMPLE TECHNOLOGIES PRIVATE LIMITED
                            official_mobile: 98*****210
                            official_email: compliance@example.com
                            official_address:
                              door_no: UNIT 402
                              building: TECH PARK
                              area: ANDHERI EAST
                              block: ANDHERI
                              street: ANDHERI KURLA ROAD
                              city: MUMBAI
                              district: MUMBAI SUBURBAN
                              state: MAHARASHTRA
                              pincode: '400093'
                            date_of_incorporation: '2015-04-01'
                            date_of_commencement: '2015-04-01'
                            date_of_udyam_registration: '2021-02-08'
                            district_industries_center: MUMBAI SUBURBAN
                            dfo: MUMBAI
                            social_category: General
                          industry:
                            - industry_code: >-
                                62 - Computer programming, consultancy and
                                related activities
                              sub_sector_code: 6201 - Computer programming activities
                              branch_sub_sector_code: >-
                                62011 - Writing, modifying, testing of computer
                                program to meet the needs of a particular client
                              activity_type: Services
                              date: '2021-02-08'
                          branch_address:
                            - name: EXAMPLE TECHNOLOGIES PRIVATE LIMITED
                              address:
                                door_no: UNIT 402
                                building: TECH PARK
                                area: ANDHERI EAST
                                block: ANDHERI
                                street: ANDHERI KURLA ROAD
                                city: MUMBAI
                                district: MUMBAI SUBURBAN
                                state: MAHARASHTRA
                                pincode: '400093'
                          pdf_url: null
                      bank:
                        reasons: []
                        details:
                          account_number: '50100123456789'
                          ifsc: HDFC0000123
                          outcome: account-valid
                          registered_name: EXAMPLE TECHNOLOGIES PRIVATE LIMITED
                          bank_name: HDFC Bank
                          branch: ANDHERI EAST
                partial:
                  summary: A finding, and a source that could not be reached
                  value:
                    bundle: business
                    credits_charged: 21
                    results:
                      company:
                        reasons: []
                        details:
                          cin: U74999MH2015PTC123456
                          company_name: EXAMPLE TECHNOLOGIES PRIVATE LIMITED
                          registration_number: '123456'
                          pan: null
                          class: PRIVATE
                          category: COMPANY LIMITED BY SHARES
                          sub_category: NON-GOVERNMENT COMPANY
                          company_type: INDIAN COMPANY
                          country_of_incorporation: INDIAN
                          date_of_incorporation: '2015-04-01'
                          status: ACTIVE
                          status_for_efiling: ACTIVE
                          status_under_cirp: null
                          active_compliance: null
                          whether_listed: UNLISTED
                          suspended_at_stock_exchange: null
                          authorised_capital: 1000000
                          paid_up_capital: 500000
                          total_obligation_of_contribution: 0
                          number_of_members: null
                          last_agm_date: '2025-09-27'
                          balance_sheet_date: '2025-03-31'
                          roc_office: ROC MUMBAI
                          nature_of_business: null
                          description_of_main_division: null
                          registered_address: >-
                            UNIT 402, 4TH FLOOR, TECH PARK, ANDHERI KURLA ROAD,
                            ANDHERI EAST, MUMBAI, MAHARASHTRA, 400093
                          address_other_than_registered_office: null
                          registered_address_split:
                            full_address: >-
                              UNIT 402, 4TH FLOOR, TECH PARK, ANDHERI KURLA
                              ROAD, ANDHERI EAST, MUMBAI, MAHARASHTRA, 400093
                            address_line1: UNIT 402, 4TH FLOOR, TECH PARK,
                            address_line2: ANDHERI KURLA ROAD, ANDHERI EAST
                            city: MUMBAI
                            state: MAHARASHTRA
                            pincode: '400093'
                          email_id: compliance@example.com
                          no_of_directors: 2
                          directorDetails:
                            - din: '01234567'
                              name: RAHUL MEHTA
                              designation: DIRECTOR
                              date_of_appointment: '2015-04-01'
                              dob: '1984-06-18'
                              nationality: INDIAN
                              citizen_of_india: true
                              resident_of_india: true
                              other_directorships:
                                listOfCompanies:
                                  - cin: U63090MH2018PTC309876
                                    company_name: EXAMPLE LOGISTICS PRIVATE LIMITED
                                    begin_date: '2018-07-02'
                                    end_date: null
                                listOfLLPs: []
                            - din: '07654321'
                              name: PRIYA NAIR
                              designation: DIRECTOR
                              date_of_appointment: '2019-11-15'
                              dob: '1988-02-09'
                              nationality: INDIAN
                              citizen_of_india: true
                              resident_of_india: true
                              other_directorships:
                                listOfCompanies: []
                                listOfLLPs: []
                      pan:
                        reasons: []
                        details:
                          pan: AAACE1234F
                          category: Company
                          status: valid
                          remarks: null
                          name_as_per_pan_match: true
                          date_of_birth_match: true
                          aadhaar_seeded: null
                      gst:
                        reasons:
                          - code: gst-not-registered-for-pan
                            message: No GST registration is held under this PAN.
                        details: null
                      udyam:
                        reasons:
                          - code: source-unavailable
                            message: This check could not be completed.
                        details: null
                      bank:
                        reasons: []
                        details:
                          account_number: '50100123456789'
                          ifsc: HDFC0000123
                          outcome: account-valid
                          registered_name: EXAMPLE TECHNOLOGIES PRIVATE LIMITED
                          bank_name: HDFC Bank
                          branch: ANDHERI EAST
        '401':
          description: The API key is missing, malformed or not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuiteError'
        '403':
          description: The key is valid but is not entitled to this feature.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuiteError'
        '422':
          description: >-
            The request failed validation, or the source would not accept the
            details in it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuiteError'
        '429':
          description: >-
            The key is not cleared for this feature, or is sending too many
            requests. Nothing was called.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuiteError'
        '503':
          description: >-
            The source could not be reached, or authentication is temporarily
            unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuiteError'
        default:
          description: The request failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuiteError'
components:
  schemas:
    BusinessBundleRequest:
      properties:
        cin:
          type: string
          pattern: ^[LU][0-9]{5}[A-Z]{2}[0-9]{4}[A-Z]{3}[0-9]{6}$
          title: Cin
          description: Corporate Identity Number of the company
        pan:
          type: string
          pattern: ^[A-Z]{3}[ABCFGHJLPT][A-Z][0-9]{4}[A-Z]$
          title: Pan
          description: Permanent Account Number to verify
        name:
          type: string
          minLength: 2
          title: Name
          description: Full name exactly as printed on the PAN card
        date_of_birth:
          type: string
          format: date
          title: Date Of Birth
          description: Date of incorporation, or date of birth for an individual holder
        account_number:
          type: string
          pattern: ^\d{5,20}$
          title: Account Number
          description: Bank account number to verify
        ifsc:
          type: string
          pattern: ^[A-Z]{4}0[A-Z0-9]{6}$
          title: Ifsc
          description: IFSC of the account's branch
      type: object
      required:
        - cin
        - pan
        - name
        - date_of_birth
        - account_number
        - ifsc
      title: BusinessBundleRequest
      description: >-
        Every identifier the bundle checks, in one flat request.


        All of them are required. The bundle runs the same checks every time, so
        what it will cost is known before it is called, and a field left out is
        a request we cannot answer rather than a smaller bundle. The PAN is read
        three times over: the registry's own record of it, the GST registrations
        held under it, and the enterprise registered under it.
    BusinessBundleResponse:
      properties:
        bundle:
          type: string
          title: Bundle
          description: The bundle that ran
        credits_charged:
          type: integer
          title: Credits Charged
          description: Credits this call deducted
        results:
          additionalProperties:
            $ref: '#/components/schemas/BundleLineResult'
          type: object
          title: Results
          description: >-
            What each line concluded, under the name the bundle publishes it as:
            `company`, `pan`, `gst`, `udyam` and `bank`
      type: object
      required:
        - bundle
        - credits_charged
        - results
      title: BusinessBundleResponse
      description: Every line's answer, and what the bundle charged.
    SuiteError:
      properties:
        code:
          type: integer
          title: Code
          description: HTTP status code of the response
        timestamp:
          type: integer
          title: Timestamp
          description: Unix millisecond timestamp of when the response was produced
        message:
          type: string
          title: Message
          description: What went wrong, in one sentence
      type: object
      required:
        - code
        - timestamp
        - message
      title: SuiteError
      description: Why a request failed.
    BundleLineResult:
      properties:
        reasons:
          items:
            $ref: '#/components/schemas/Reason'
          type: array
          title: Reasons
          description: >-
            Why the check did not pass, worst first, each a stable code with the
            text for it. Empty when it passed
        details:
          anyOf:
            - $ref: '#/components/schemas/LineDetails'
            - type: 'null'
          description: The record the source held
      type: object
      title: BundleLineResult
      description: >-
        What one line of the bundle concluded.


        No price of its own: the bundle is sold as one thing, so what it charges
        is stated once on the response and never split across the lines.
    Reason:
      properties:
        code:
          $ref: '#/components/schemas/ReasonCode'
          description: Stable code to branch on
        message:
          type: string
          title: Message
          description: What the code means, in one sentence
      type: object
      required:
        - code
        - message
      title: Reason
      description: One machine-readable reason a check did not pass.
    LineDetails:
      anyOf:
        - $ref: '#/components/schemas/CinDetailedInfo'
        - $ref: '#/components/schemas/PanVerificationResult'
        - $ref: '#/components/schemas/GstRegistrationDetail'
        - $ref: '#/components/schemas/MsmeInfo'
        - $ref: '#/components/schemas/BankAccountDetails'
    ReasonCode:
      type: string
      enum:
        - cin-not-registered
        - gstin-not-registered
        - gstin-inactive
        - pan-inactive
        - pan-name-mismatch
        - pan-date-of-birth-mismatch
        - udyam-not-registered
        - udyam-not-registered-for-pan
        - udyam-cancelled
        - gst-not-registered-for-pan
        - company-not-registered-for-pan
        - epfo-member-not-found
        - uan-not-registered-for-pan
        - driving-licence-not-registered
        - driving-licence-details-mismatch
        - driving-licence-expired
        - uan-not-registered-for-mobile
        - passport-not-registered
        - passport-name-mismatch
        - source-unavailable
        - details-refused
        - bank-account-unverified
        - bank-account-unsettled
      title: ReasonCode
      description: >-
        Why a check did not pass, as the stable code a client branches on.


        Declared rather than written as strings so that every code a check can
        answer with reaches the published schema, and a client reads the whole
        set from the API reference.
    CinDetailedInfo:
      properties:
        cin:
          type: string
          title: Cin
        company_name:
          type: string
          title: Company Name
        registration_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Registration Number
        pan:
          anyOf:
            - type: string
            - type: 'null'
          title: Pan
        class:
          anyOf:
            - type: string
            - type: 'null'
          title: Class
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
        sub_category:
          anyOf:
            - type: string
            - type: 'null'
          title: Sub Category
        company_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Company Type
        country_of_incorporation:
          anyOf:
            - type: string
            - type: 'null'
          title: Country Of Incorporation
        date_of_incorporation:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Date Of Incorporation
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        status_for_efiling:
          anyOf:
            - type: string
            - type: 'null'
          title: Status For Efiling
        status_under_cirp:
          anyOf:
            - type: string
            - type: 'null'
          title: Status Under Cirp
        active_compliance:
          anyOf:
            - type: string
            - type: 'null'
          title: Active Compliance
        whether_listed:
          anyOf:
            - type: string
            - type: 'null'
          title: Whether Listed
        suspended_at_stock_exchange:
          anyOf:
            - type: string
            - type: 'null'
          title: Suspended At Stock Exchange
        authorised_capital:
          anyOf:
            - type: integer
            - type: 'null'
          title: Authorised Capital
        paid_up_capital:
          anyOf:
            - type: integer
            - type: 'null'
          title: Paid Up Capital
        total_obligation_of_contribution:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total Obligation Of Contribution
        number_of_members:
          anyOf:
            - type: integer
            - type: 'null'
          title: Number Of Members
        last_agm_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Last Agm Date
        balance_sheet_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Balance Sheet Date
        roc_office:
          anyOf:
            - type: string
            - type: 'null'
          title: Roc Office
        nature_of_business:
          anyOf:
            - type: string
            - type: 'null'
          title: Nature Of Business
        description_of_main_division:
          anyOf:
            - type: string
            - type: 'null'
          title: Description Of Main Division
        registered_address:
          anyOf:
            - type: string
            - type: 'null'
          title: Registered Address
        address_other_than_registered_office:
          anyOf:
            - type: string
            - type: 'null'
          title: Address Other Than Registered Office
        registered_address_split:
          anyOf:
            - $ref: '#/components/schemas/RegisteredAddressSplit'
            - type: 'null'
        email_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Email Id
        no_of_directors:
          anyOf:
            - type: integer
            - type: 'null'
          title: No Of Directors
        directorDetails:
          items:
            $ref: '#/components/schemas/Director'
          type: array
          title: Directordetails
      type: object
      required:
        - cin
        - company_name
      title: CinDetailedInfo
      description: >-
        The ROC profile of a company, its board, and each director's other
        directorships.
    PanVerificationResult:
      properties:
        pan:
          type: string
          title: Pan
        category:
          $ref: '#/components/schemas/PanType'
        status:
          $ref: '#/components/schemas/PanStatus'
        remarks:
          anyOf:
            - type: string
            - type: 'null'
          title: Remarks
        name_as_per_pan_match:
          type: boolean
          title: Name As Per Pan Match
        date_of_birth_match:
          type: boolean
          title: Date Of Birth Match
        aadhaar_seeded:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Aadhaar Seeded
      type: object
      required:
        - pan
        - category
        - status
        - name_as_per_pan_match
        - date_of_birth_match
        - aadhaar_seeded
      title: PanVerificationResult
      description: >-
        Result of a Verify-PAN-Details call.


        The vendor's own transaction id is left in the raw payload rather than
        read onto this: it names a call of ours and says nothing about the PAN,
        and this shape is published to clients.
    GstRegistrationDetail:
      properties:
        gstin:
          type: string
          pattern: ^\d{2}[A-Z]{5}\d{4}[A-Z]{1}[A-Z\d]{1}Z[A-Z\d]{1}$
          title: Gstin
        legal_name:
          type: string
          title: Legal Name
        trade_name:
          type: string
          title: Trade Name
        registration_date:
          type: string
          format: date
          title: Registration Date
        cancellation_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Cancellation Date
        registration_status:
          $ref: '#/components/schemas/GstinStatus'
        jurisdiction:
          $ref: '#/components/schemas/Jurisdiction'
        primary_business_address:
          anyOf:
            - $ref: '#/components/schemas/Address'
            - type: 'null'
        other_business_address:
          anyOf:
            - $ref: '#/components/schemas/Address'
            - type: 'null'
        business_constitution:
          $ref: '#/components/schemas/BusinessConstitution'
        business_nature:
          items:
            $ref: '#/components/schemas/NatureOfBusinessActivities'
          type: array
          title: Business Nature
        taxpayer_type:
          $ref: '#/components/schemas/TaxpayerType'
        e_invoice_mandated:
          type: boolean
          title: E Invoice Mandated
      type: object
      required:
        - gstin
        - legal_name
        - trade_name
        - registration_date
        - cancellation_date
        - registration_status
        - jurisdiction
        - primary_business_address
        - other_business_address
        - business_constitution
        - business_nature
        - taxpayer_type
        - e_invoice_mandated
      title: GstRegistrationDetail
      description: >-
        Who holds a registration, where, under what form, and whether it still
        stands.


        What a source states about a registration in full, whether it was
        reached by its own GSTIN or listed among the ones a PAN holds. A search
        that answers with the GSTIN and its standing alone states
        ``GstRegistration`` instead, which is a different question and a
        different row.
    MsmeInfo:
      properties:
        pan:
          anyOf:
            - type: string
              pattern: ^[A-Z]{3}[ABCFGHJLPT][A-Z][0-9]{4}[A-Z]$
            - type: 'null'
          title: Pan
        enterprise_data:
          $ref: '#/components/schemas/UdyamEnterpriseData'
        industry:
          items:
            $ref: '#/components/schemas/UdyamIndustry'
          type: array
          title: Industry
        branch_address:
          items:
            $ref: '#/components/schemas/UdyamBranch'
          type: array
          title: Branch Address
        pdf_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Pdf Url
      type: object
      required:
        - enterprise_data
        - industry
        - branch_address
      title: MsmeInfo
      description: MSME (Udyam) registration info, as a registry states it.
    BankAccountDetails:
      properties:
        account_number:
          type: string
          title: Account Number
          description: The account that was checked
        ifsc:
          type: string
          title: Ifsc
          description: IFSC of the account's branch
        outcome:
          type: string
          title: Outcome
          description: What the banking network answered for the account
        registered_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Registered Name
          description: The name the bank holds the account in, where it returned one
        bank_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Bank Name
          description: The bank behind the IFSC, where it was resolved
        branch:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch
          description: The branch behind the IFSC, where it was resolved
      type: object
      required:
        - account_number
        - ifsc
        - outcome
      title: BankAccountDetails
      description: >-
        The account as the bank stated it.


        No name comparison is carried. The source is given no name to match
        against, so the registered name is reported as the bank spells it and
        the comparison is the caller's to make against whatever name they
        expected.
    RegisteredAddressSplit:
      properties:
        full_address:
          anyOf:
            - type: string
            - type: 'null'
          title: Full Address
        address_line1:
          anyOf:
            - type: string
            - type: 'null'
          title: Address Line1
        address_line2:
          anyOf:
            - type: string
            - type: 'null'
          title: Address Line2
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
        state:
          anyOf:
            - type: string
            - type: 'null'
          title: State
        pincode:
          anyOf:
            - type: string
            - type: 'null'
          title: Pincode
      type: object
      title: RegisteredAddressSplit
      description: >-
        The registered address in components, which the payload carries only
        when it was asked for.
    Director:
      properties:
        din:
          anyOf:
            - type: string
            - type: 'null'
          title: Din
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        designation:
          anyOf:
            - type: string
            - type: 'null'
          title: Designation
        date_of_appointment:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Date Of Appointment
        dob:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Dob
        nationality:
          anyOf:
            - type: string
            - type: 'null'
          title: Nationality
        citizen_of_india:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Citizen Of India
        resident_of_india:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Resident Of India
        other_directorships:
          $ref: '#/components/schemas/OtherDirectorships'
      type: object
      title: Director
      description: A director or key managerial person on the company's board.
    PanType:
      type: string
      enum:
        - Individual
        - Company
        - HUF
        - Firm
        - AOP
        - Trust
        - Body of Individuals
        - Local Authority
        - Artificial Juridical Person
        - Government
        - Unknown
      title: PanType
      description: Enumeration of possible PAN types.
    PanStatus:
      type: string
      enum:
        - valid
        - invalid
      title: PanStatus
      description: Whether official records hold the PAN as a live one.
    GstinStatus:
      type: string
      enum:
        - Active
        - Inactive
        - Cancelled
        - Active pending Verification
        - Suspended
        - Cancelled due to expiry of registration period
        - Cancelled on Request of Taxpayer
        - Cancelled on application of Taxpayer
        - Cancelled suo-moto
        - Not Migrated
        - Unknown
      title: GstinStatus
      description: The standing of a GST registration.
    Jurisdiction:
      properties:
        state:
          type: string
          title: State
        central:
          type: string
          title: Central
      type: object
      required:
        - state
        - central
      title: Jurisdiction
      description: GST jurisdiction information.
    Address:
      properties:
        street:
          type: string
          title: Street
        city:
          type: string
          title: City
        state:
          $ref: '#/components/schemas/State'
        country:
          $ref: '#/components/schemas/Country'
          default: India
        postal_code:
          type: string
          title: Postal Code
      type: object
      required:
        - street
        - city
        - state
        - postal_code
      title: Address
      description: A postal address.
    BusinessConstitution:
      type: string
      enum:
        - Sole Proprietorship
        - Partnership
        - Hindu Undivided Family
        - Private Limited Company
        - Public Limited Company
        - One Person Company
        - Limited Liability Partnership
        - Foreign Limited Liability Partnership
        - Foreign Company
        - Unlimited Company
        - Public Sector Undertaking
        - Society/ Club/ Trust/ AOP
        - Government Department
        - Local Authority
        - Statutory Body
        - Trust
        - Others
      title: BusinessConstitution
      description: >-
        The legal form a business is registered under, named as the registry
        names it.


        OTHERS carries a constitution the registry states and this list does not
        name, so a form outside it is still recorded as a registration rather
        than refused.
    NatureOfBusinessActivities:
      type: string
      enum:
        - Input Service Distributor (ISD)
        - Bonded Warehouse
        - SEZ
        - Leasing Business
        - Service Provision
        - Import
        - Works Contract
        - Others
        - Office / Sale Office
        - EOU / STP / EHTP
        - Factory / Manufacturing
        - Recipient of Goods or Services
        - Retail Business
        - Supplier of Services
        - Wholesale Business
        - Warehouse / Depot
        - Export
      title: NatureOfBusinessActivities
      description: >-
        A way a registration is registered to operate. Most registrations name
        more than one.
    TaxpayerType:
      type: string
      enum:
        - Regular
        - Tax Deductor
        - Tax Collector (Electronic Commerce Operator)
        - Composition
        - Exempted
        - SEZ Unit
        - Casual Taxable Person
        - Input Service Distributor (ISD)
        - Unregistered Applicant
        - SEZ Developer
        - Consulate or Embassy of Foreign Country
        - United Nation Body
        - Other Notified Person
        - Non-Resident Online Services Provider
        - Unknown
      title: TaxpayerType
      description: >-
        How a registration taxes the business it belongs to.


        UNKNOWN carries a type the registry states and this list does not name,
        so a registration under one is still recorded rather than refused.
    UdyamEnterpriseData:
      properties:
        udyam_reg_no:
          type: string
          title: Udyam Reg No
        major_activity:
          $ref: '#/components/schemas/UdyamActivity'
        enterprise_type:
          $ref: '#/components/schemas/EmptyToNone_UdyamEnterpriseType_'
        organization_type:
          $ref: '#/components/schemas/UdyamOrganizationType'
        official_name:
          type: string
          title: Official Name
        official_mobile:
          type: string
          title: Official Mobile
        official_email:
          type: string
          title: Official Email
        official_address:
          $ref: '#/components/schemas/UdyamAddress'
        date_of_incorporation:
          type: string
          format: date
          title: Date Of Incorporation
        date_of_commencement:
          $ref: '#/components/schemas/EmptyToNone_date_'
        date_of_udyam_registration:
          type: string
          format: date
          title: Date Of Udyam Registration
        district_industries_center:
          type: string
          title: District Industries Center
        dfo:
          type: string
          title: Dfo
        social_category:
          $ref: '#/components/schemas/UdyamSocialCategory'
      type: object
      required:
        - udyam_reg_no
        - major_activity
        - organization_type
        - official_name
        - official_mobile
        - official_email
        - official_address
        - date_of_incorporation
        - date_of_udyam_registration
        - district_industries_center
        - dfo
        - social_category
      title: UdyamEnterpriseData
      description: Core enterprise data for an Udyam registration.
    UdyamIndustry:
      properties:
        industry_code:
          type: string
          title: Industry Code
        sub_sector_code:
          type: string
          title: Sub Sector Code
        branch_sub_sector_code:
          type: string
          title: Branch Sub Sector Code
        activity_type:
          $ref: '#/components/schemas/UdyamActivity'
        date:
          $ref: '#/components/schemas/EmptyToNone_date_'
      type: object
      required:
        - industry_code
        - sub_sector_code
        - branch_sub_sector_code
        - activity_type
      title: UdyamIndustry
      description: Industry classification entry for an Udyam enterprise.
    UdyamBranch:
      properties:
        name:
          type: string
          title: Name
        address:
          $ref: '#/components/schemas/UdyamAddress'
      type: object
      required:
        - name
        - address
      title: UdyamBranch
      description: Udyam branch entry.
    OtherDirectorships:
      properties:
        listOfCompanies:
          items:
            $ref: '#/components/schemas/Directorship'
          type: array
          title: Listofcompanies
        listOfLLPs:
          items:
            $ref: '#/components/schemas/Directorship'
          type: array
          title: Listofllps
      type: object
      title: OtherDirectorships
      description: >-
        The other entities a director is associated with, which is what this
        product adds over a simple search.


        An LLP turns up in either list, so a reader after every entity reads
        both rather than picking one.
    State:
      type: string
      enum:
        - Andaman and Nicobar Islands
        - Andhra Pradesh
        - Arunachal Pradesh
        - Assam
        - Bihar
        - Chandigarh
        - Chhattisgarh
        - Dadra and Nagar Haveli and Daman and Diu
        - Delhi
        - Goa
        - Gujarat
        - Haryana
        - Himachal Pradesh
        - Jammu and Kashmir
        - Jharkhand
        - Karnataka
        - Kerala
        - Lakshadweep
        - Ladakh
        - Madhya Pradesh
        - Maharashtra
        - Manipur
        - Meghalaya
        - Mizoram
        - Nagaland
        - Odisha
        - Puducherry
        - Punjab
        - Rajasthan
        - Sikkim
        - Tamil Nadu
        - Telangana
        - Tripura
        - Uttar Pradesh
        - Uttarakhand
        - West Bengal
      title: State
      description: A state.
    Country:
      type: string
      enum:
        - India
      title: Country
      description: A country.
    UdyamActivity:
      type: string
      enum:
        - Manufacturing
        - Services
        - Trading
      title: UdyamActivity
      description: >-
        What an enterprise does, which the registry states for the enterprise
        and for each industry.
    EmptyToNone_UdyamEnterpriseType_:
      anyOf:
        - $ref: '#/components/schemas/UdyamEnterpriseType'
        - type: 'null'
    UdyamOrganizationType:
      type: string
      enum:
        - Proprietary
        - Hindu Undivided Family
        - Partnership
        - Co-Operative
        - Private Limited Company
        - Public Limited Company
        - Self Help Group
        - Limited Liability Partnership
        - Society
        - Trust
        - Others
      title: UdyamOrganizationType
      description: >-
        The legal form an enterprise is registered under.


        Udyam spells these its own way: a sole proprietorship registers as
        PROPRIETARY, and a form the registry does not name registers as OTHERS.
    UdyamAddress:
      properties:
        door_no:
          type: string
          title: Door No
        building:
          type: string
          title: Building
        area:
          type: string
          title: Area
        block:
          type: string
          title: Block
        street:
          type: string
          title: Street
        city:
          type: string
          title: City
        district:
          type: string
          title: District
        state:
          type: string
          title: State
        pincode:
          type: string
          title: Pincode
      type: object
      required:
        - door_no
        - building
        - area
        - block
        - street
        - city
        - district
        - state
        - pincode
      title: UdyamAddress
      description: Udyam registered address.
    EmptyToNone_date_:
      anyOf:
        - type: string
          format: date
        - type: 'null'
    UdyamSocialCategory:
      type: string
      enum:
        - General
        - SC
        - ST
        - OBC
      title: UdyamSocialCategory
      description: The social category the enterprise's proprietor is registered under.
    Directorship:
      properties:
        cin:
          anyOf:
            - type: string
            - type: 'null'
          title: Cin
        company_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Company Name
        begin_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Begin Date
        end_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: End Date
      type: object
      title: Directorship
      description: >-
        One company or LLP a director is associated with, over the dates they
        held it.
    UdyamEnterpriseType:
      type: string
      enum:
        - Micro
        - Small
        - Medium
      title: UdyamEnterpriseType
      description: The size class an enterprise is registered as.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key, sent as `Authorization: Bearer <your-key>`.'

````

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