# GST No. Verifer (`mikolabs/gst`) Actor

An automated Apify actor that verifies Indian GST (Goods and Services Tax) numbers and retrieves comprehensive taxpayer information from the official GST portal.

- **URL**: https://apify.com/mikolabs/gst.md
- **Developed by:** [mikolabs](https://apify.com/mikolabs) (community)
- **Categories:** Other, Integrations, Developer tools
- **Stats:** 19 total users, 2 monthly users, 88.9% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $5.00 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## GST Verification Apify Actor

This Apify actor verifies GST (Goods and Services Tax) numbers and retrieves detailed taxpayer information from the official Indian GST portal.

### Features

- ✅ Verifies GST numbers using the official GST portal
- ✅ Handles session management automatically
- ✅ Fetches captcha images for verification
- ✅ Retrieves comprehensive GST taxpayer details
- ✅ Returns structured JSON data
- ✅ Easy to integrate with Apify platform

### Input

The actor accepts the following input parameters:

```json
{
  "GSTIN": "27CEGPN9391P1ZF",
  "captcha": "ABC123"
}
````

#### Input Parameters

- **GSTIN** (required): The GST Identification Number to verify (15 characters)
  - Format: `27CEGPN9391P1ZF`
  - Example: `27AAPFU0939F1Z5`

- **captcha** (optional): The captcha text to solve
  - If not provided, the actor will output the captcha image and require manual input
  - You can use captcha solving services or solve it manually

### Output

The actor outputs GST details in the following format:

#### Success Response

```json
{
  "gstin": "27CEGPN9391P1ZF",
  "status": "success",
  "data": {
    "adhrVFlag": "Yes",
    "adhrVdt": "29/01/2021",
    "cmpRt": "NA",
    "ctb": "Proprietorship",
    "ctj": "Address",
    "cxdt": "",
    "dty": "Regular",
    "einvoiceStatus": "No",
    "ekycVFlag": "Not Applicable",
    "gstin": "27CEGPN9391P1ZF",
    "isFieldVisitConducted": "No",
    "lgnm": "COMPANY NAME",
    "nba": [
      "Retail Business",
      "Wholesale Business",
      "Supplier of Services"
    ],
    "ntcrbs": "TRD:TRR",
    "pradr": {
      "adr": "Full Address"
    },
    "rgdt": "Registration Date",
    "stj": "Division",
    "sts": "Status",
    "tradeNam": "Trade Name"
  }
}
```

#### Captcha Required Response

```json
{
  "gstin": "27CEGPN9391P1ZF",
  "captchaImage": "data:image/png;base64,...",
  "status": "captcha_required",
  "message": "Please solve the captcha and provide it in the input"
}
```

#### Error Response

```json
{
  "gstin": "27CEGPN9391P1ZF",
  "error": "Error message",
  "status": "error"
}
```

### Usage

#### Using Apify Console

1. Go to [Apify Console](https://console.apify.com/)
2. Create a new actor or use this actor
3. Configure the input with your GSTIN
4. Run the actor
5. If captcha is required, solve it and provide it in the input
6. Retrieve the results from the dataset

#### Using Apify API

```python
from apify_client import ApifyClient

## Initialize the ApifyClient
client = ApifyClient("YOUR_API_TOKEN")

## Prepare the actor input
run_input = {
    "GSTIN": "27CEGPN9391P1ZF",
    "captcha": "ABC123"  # Optional, if not provided, captcha image will be returned
}

## Run the actor
run = client.actor("YOUR_USERNAME/gst-verification").call(run_input=run_input)

## Fetch results from the default dataset
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)
```

#### Using cURL

```bash
curl -X POST \
  https://api.apify.com/v2/acts/YOUR_USERNAME~gst-verification/runs \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "GSTIN": "27CEGPN9391P1ZF",
    "captcha": "ABC123"
  }'
```

### Workflow

1. **Initialize Session**: The actor creates a session with the GST portal
2. **Fetch Captcha**: Retrieves a captcha image from the GST portal
3. **Solve Captcha**: If captcha is provided, proceeds to verification; otherwise, outputs captcha image
4. **Verify GSTIN**: Submits GSTIN and captcha to the GST portal
5. **Retrieve Details**: Fetches and returns comprehensive GST taxpayer details

### Support

For issues, questions, or contributions, please open an issue on the repository.

### License

This project is provided as-is for educational and legitimate business purposes. Please ensure compliance with the GST portal's terms of service.

### Disclaimer

This actor is for legitimate verification purposes only. Users are responsible for ensuring compliance with all applicable laws and regulations when using this actor.

# Actor input Schema

## `GSTIN` (type: `string`):

The GST Identification Number (GSTIN) to verify. Format: 15 characters (e.g., 27CEGPN9391P1ZF)

## `captchaRetryAttempts` (type: `integer`):

Number of times to retry captcha solving if it fails (default: 3, range: 1-5)

## `maxRetryAttempts` (type: `integer`):

Maximum number of times to retry GST verification if data is all N/A (default: 3, range: 1-10)

## Actor input object example

```json
{
  "GSTIN": "27CEGPN9391P1ZF",
  "captchaRetryAttempts": 3,
  "maxRetryAttempts": 3
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "GSTIN": "27CEGPN9391P1ZF"
};

// Run the Actor and wait for it to finish
const run = await client.actor("mikolabs/gst").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "GSTIN": "27CEGPN9391P1ZF" }

# Run the Actor and wait for it to finish
run = client.actor("mikolabs/gst").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "GSTIN": "27CEGPN9391P1ZF"
}' |
apify call mikolabs/gst --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=mikolabs/gst",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "GST No. Verifer",
        "description": "An automated Apify actor that verifies Indian GST (Goods and Services Tax) numbers and retrieves comprehensive taxpayer information from the official GST portal.",
        "version": "1.0",
        "x-build-id": "MViKw2QsenZ6H2si3"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/mikolabs~gst/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-mikolabs-gst",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/mikolabs~gst/runs": {
            "post": {
                "operationId": "runs-sync-mikolabs-gst",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/mikolabs~gst/run-sync": {
            "post": {
                "operationId": "run-sync-mikolabs-gst",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "required": [
                    "GSTIN"
                ],
                "properties": {
                    "GSTIN": {
                        "title": "GSTIN",
                        "pattern": "^[0-9]{2}[A-Z]{5}[0-9]{4}[A-Z]{1}[1-9A-Z]{1}Z[0-9A-Z]{1}$",
                        "minLength": 15,
                        "maxLength": 15,
                        "type": "string",
                        "description": "The GST Identification Number (GSTIN) to verify. Format: 15 characters (e.g., 27CEGPN9391P1ZF)"
                    },
                    "captchaRetryAttempts": {
                        "title": "Captcha Retry Attempts",
                        "minimum": 1,
                        "maximum": 5,
                        "type": "integer",
                        "description": "Number of times to retry captcha solving if it fails (default: 3, range: 1-5)",
                        "default": 3
                    },
                    "maxRetryAttempts": {
                        "title": "Max Retry Attempts for Data Retrieval",
                        "minimum": 1,
                        "maximum": 10,
                        "type": "integer",
                        "description": "Maximum number of times to retry GST verification if data is all N/A (default: 3, range: 1-10)",
                        "default": 3
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```