generated: '2026-10-18'
method: derived
generator: derive-vocabulary.py
source: openapi/gstinapi-openapi.yml
vocabulary:
  name: GSTIN API Domain Vocabulary
  description: 'Terms declared by GSTIN API''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-18'
  terms:
  - term: Verification
    definition: Verify a single GSTIN.
    tags:
    - Resource Group
    source: openapi/gstinapi-openapi.yml
  - term: Bulk
    definition: Verify a list of GSTINs as an asynchronous job.
    tags:
    - Resource Group
    source: openapi/gstinapi-openapi.yml
  - term: BulkJobRequest
    definition: Supply exactly one of `gstins` or `text`.
    tags:
    - Object
    source: openapi/gstinapi-openapi.yml#/components/schemas/BulkJobRequest
  - term: BulkJobEnvelope
    definition: 'Object declared by the contract with fields: success, job, links.'
    tags:
    - Object
    source: openapi/gstinapi-openapi.yml#/components/schemas/BulkJobEnvelope
  - term: BulkJob
    definition: A submitted list and how far through it we are.
    tags:
    - Object
    source: openapi/gstinapi-openapi.yml#/components/schemas/BulkJob
  - term: BulkResultRow
    definition: One submitted row and what became of it.
    tags:
    - Object
    source: openapi/gstinapi-openapi.yml#/components/schemas/BulkResultRow
  - term: Outcome
    definition: 'What happened to a row, and whether it cost anything: - `ok` — a live registration was found. **One credit.** - `not_found` —
      well-formed, but no registration exists. Free. - `invalid_format` — not a valid GSTIN; rejected on its checksum without contacting the government
      source. Free. - `upstream_error` — the government source could not answer. Free; resubmit the row. - `skipped` — the job was can'
    tags:
    - Enumeration
    source: openapi/gstinapi-openapi.yml#/components/schemas/Outcome
  - term: TaxpayerProfile
    definition: A verified registration, normalised. This is the shape bulk results carry; the single endpoint returns the raw envelope instead.
    tags:
    - Object
    source: openapi/gstinapi-openapi.yml#/components/schemas/TaxpayerProfile
  - term: TaxpayerEnvelope
    definition: The government data source payload, passed through verbatim. Check `taxpayer_data.status_code` — `1` is a live registration, `0`
      means no registration exists for this number and carries an error code instead.
    tags:
    - Object
    source: openapi/gstinapi-openapi.yml#/components/schemas/TaxpayerEnvelope
  - term: Pagination
    definition: 'Object declared by the contract with fields: page, per_page, total, last_page, has_more.'
    tags:
    - Object
    source: openapi/gstinapi-openapi.yml#/components/schemas/Pagination
  - term: Error
    definition: 'Object declared by the contract with fields: success, reason, message.'
    tags:
    - Object
    source: openapi/gstinapi-openapi.yml#/components/schemas/Error