GSTIN Rating

Get the monthly GST compliance rating for a GSTIN, including filing pattern and return type history.

Endpoint

POST /vas-api/v1/gstin-rating

Request

Body parameters

Field	Type	Required	Description	Example
gstin	string	Yes	15-character GSTIN	29ABCDE1234F1Z5

Example request

curl

curl -X POST https://api.api4business.com/vas-api/v1/gstin-rating \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"gstin": "29ABCDE1234F1Z5"}'

Python

import requests

response = requests.post(
  "https://api.api4business.com/vas-api/v1/gstin-rating",
  headers={"Authorization": "Bearer YOUR_ACCESS_TOKEN", "Content-Type": "application/json"},
  json={"gstin": "29ABCDE1234F1Z5"}
)
print(response.json())

Node.js

const response = await fetch("https://api.api4business.com/vas-api/v1/gstin-rating", {
  method: "POST",
  headers: { "Authorization": "Bearer YOUR_ACCESS_TOKEN", "Content-Type": "application/json" },
  body: JSON.stringify({ gstin: "29ABCDE1234F1Z5" })
});
console.log(await response.json());

Java

HttpRequest request = HttpRequest.newBuilder()
  .uri(URI.create("https://api.api4business.com/vas-api/v1/gstin-rating"))
  .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
  .header("Content-Type", "application/json")
  .POST(HttpRequest.BodyPublishers.ofString("{\"gstin\": \"29ABCDE1234F1Z5\"}"))
  .build();

Response

Success (200)

Field	Type	Description
body.gstin	string	The GSTIN checked
body.pattern	string	Filing pattern (monthly, quarterly)
body.return_type_list	array	Return types filed (e.g., GSTR1, GSTR3B, CMP08)
body.visual_data.rating	object	Monthly rating scores (1-5 scale per month)
body.visual_data.fin_yr	string	Financial year for the rating

Example response

{
  "ok": true,
  "responseCode": 200,
  "message": "Transmission OK",
  "body": {
    "gstin": "29ABCDE1234F1Z5",
    "pattern": "monthly",
    "return_type_list": ["GSTR1", "GSTR3B"],
    "visual_data": {
      "gstin": "29ABCDE1234F1Z5",
      "fin_yr": "2024-2025",
      "rating": {
        "Apr": 4.5, "May": 4, "Jun": 5, "Jul": 4,
        "Aug": 4, "Sep": 5, "Oct": 4, "Nov": 4,
        "Dec": 5, "Jan": 4, "Feb": 4, "Mar": 0
      }
    }
  }
}

Response headers

Header	Description
x-request-id	Unique request identifier — log this for debugging and support

Error responses

Status	Message	Resolution
400	Invalid GSTIN	Check 15-character format
401	Invalid Credentials	Refresh access token
429	Quota Violation	Retry with backoff
500	Internal Server Error	Retry after delay

Related

• GSTIN Status — Get registration details
• GST Filing Details — Full filing history

Rating scale

Monthly ratings are on a 1-5 scale. A score of 5 indicates perfect compliance for that month. A score of 0 typically means the return for that month has not yet been filed or the data is not yet available from GSTN.