TaxpayerEnvelope

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gstinapi/main/json-schema/gstinapi-taxpayer-envelope-schema.json",
  "title": "TaxpayerEnvelope",
  "description": "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.",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/gstinapi-openapi.yml#/components/schemas/TaxpayerEnvelope",
  "type": "object",
  "properties": {
    "taxpayer_data": {
      "type": "object",
      "properties": {
        "status_code": {
          "type": "integer",
          "enum": [
            0,
            1
          ]
        },
        "gstin": {
          "type": "string"
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Legal name of the registered taxpayer."
        },
        "tradename": {
          "type": [
            "string",
            "null"
          ]
        },
        "status": {
          "type": [
            "string",
            "null"
          ]
        },
        "registrationDate": {
          "type": [
            "string",
            "null"
          ]
        },
        "constitution": {
          "type": [
            "string",
            "null"
          ]
        },
        "pradr": {
          "type": [
            "object",
            "null"
          ],
          "description": "Principal place of business, as a structured object."
        },
        "adadr": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object"
          },
          "description": "Additional places of business."
        },
        "einvoiceStatus": {
          "type": [
            "string",
            "null"
          ]
        },
        "error": {
          "type": [
            "object",
            "null"
          ],
          "description": "Present when `status_code` is 0.",
          "properties": {
            "error_cd": {
              "type": "string"
            },
            "message": {
              "type": "string"
            }
          }
        }
      }
    },
    "filing_data": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Recent GSTR filings with period, ARN and filed status."
    },
    "preference_data": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "nc_data": {
      "type": "object",
      "description": "E-invoicing and e-way bill activity."
    }
  }
}