# GST Taxpayer API

The full public GST record for any Indian GSTIN: the registration snapshot (legal and trade name, address, status, constitution, jurisdiction, Aadhaar and e-KYC flags), plus the nested return-filing history, HSN goods and SAC services, filing frequency by financial year, and additional trade names.

**Pricing:** $0.05 per taxpayer

**Endpoint:** `POST /v1/data/gst-info/taxpayer/run`

**Auth:** `Authorization: Bearer mk_live_...`

## Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `gstins` | array | Yes | One or more 15-character GSTINs. Each is checksum-validated before anything is fetched, so a typo costs nothing. Each GSTIN returns one row. |
| `maxResults` | integer | No | Stop after this many have been looked up. Each one costs a row, so this caps the bill as well as the output. 0 or omitted means every id you sent. |

## Example

`?wait=true` holds the request open until the run finishes (up to 60s) and returns the rows inline — one request, no polling.

```bash
curl -X POST "https://api.mindcase.co/v1/data/gst-info/taxpayer/run?wait=true" \
  -H "Authorization: Bearer mk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"params":{"gstins":["..."]}}'
```

```python
import requests

resp = requests.post(
    "https://api.mindcase.co/v1/data/gst-info/taxpayer/run",
    params={"wait": "true"},
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
    json={"params": {
    "gstins": [
        "..."
    ]
}},
)
rows = resp.json()["data"]
```

## Longer runs

If the run is still going at the 60s ceiling you get back `{ job_id, status: "running" }` instead of rows (same if the result is over 100 rows — those come back `truncated`). Poll with that `job_id`:

```bash
# 1) check status
curl https://api.mindcase.co/v1/jobs/JOB_ID \
  -H "Authorization: Bearer mk_live_YOUR_API_KEY"

# 2) when status == completed, fetch the rows
curl https://api.mindcase.co/v1/jobs/JOB_ID/results \
  -H "Authorization: Bearer mk_live_YOUR_API_KEY"
```

Full API reference (auth, jobs, balance, SDKs, MCP): https://mindcase.co/skills.md

## Response columns

| Field | Display name | Type |
|-------|--------------|------|
| `gstin` | GSTIN | text |
| `legalName` | Legal Name | text |
| `tradeName` | Trade Name | text |
| `registrationStatus` | Registration Status | text |
| `taxpayerType` | Taxpayer Type | text |
| `constitutionOfBusiness` | Constitution of Business | text |
| `natureOfCoreBusiness` | Nature of Core Business | text |
| `registrationDate` | Registration Date | date |
| `cancellationDate` | Cancellation Date | date |
| `principalPlaceOfBusiness` | Principal Place of Business | text |
| `natureOfBusinessActivities` | Nature of Business Activities | array |
| `stateJurisdiction` | State Jurisdiction | text |
| `centreJurisdiction` | Centre Jurisdiction | text |
| `aadhaarVerified` | Aadhaar Verified | text |
| `aadhaarVerificationDate` | Aadhaar Verification Date | date |
| `ekycVerified` | eKYC Verified | text |
| `ekycVerificationDate` | eKYC Verification Date | date |
| `eInvoiceEnabled` | e-Invoice Enabled | text |
| `compositionRate` | Composition Rate | text |
| `fieldVisitConducted` | Field Visit Conducted | text |
| `registeredFinancialYears` | Registered Financial Years | object_array |
| `hsnGoods` | HSN Goods | object_array |
| `sacServices` | SAC Services | object_array |
| `returnFilings` | Return Filings | object_array |
| `filingPreferences` | Filing Preferences | object_array |
| `additionalTradeNames` | Additional Trade Names | array |
| `scrapedAt` | Scraped At | date |