Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.1.0",
"info": {
"title": "Vayana API Documentation",
"version": "1.0.0",
"description": "To integrate these APIs please follow documentation"
},
"servers": [
{
"url": "https://s.api.one.vayana.com",
"description": "Sandbox Server"
}
],
"paths": {
"/atlas/v1/gstin/{gstin}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "GSTIN Verification",
"description": "Search Taxpayer Detail API fetches all public information available with GSTN portal. This information was given during the time of GST Registration of the Taxpayer. All you need to check out the latest version which GSTN has released for the api for an environment (ie production and sandbox).",
"operationId": "eas_basic_v1_gstn_search_gstin",
"_peer-api": "/basic/gstn/v3.0/commonapi/v0.3/search?gstin=33AOZPD0347J5ZO&action=TP",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"name": "X-FLYNN-N-GSTN-GSP-CODE",
"in": "header",
"required": true,
"description": "GSP Identifier",
"schema": {
"type": "string",
"enum": [
"vay"
]
}
},
{
"required": true,
"schema": {
"type": "string",
"maxLength": 15,
"example": "29HJKPS9689A8Z5"
},
"description": "GSTIN to search",
"name": "gstin",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"adadr": {
"items": {
"properties": {
"addr": {
"properties": {
"bnm": {
"type": "string",
"description": "Building Name",
"example": "ELPHINSTONE BUILDING"
},
"bno": {
"type": "string",
"description": "Building Number",
"example": "10"
},
"flno": {
"type": "string",
"description": "Floor number",
"example": "1ST FLOOR"
},
"lg": {
"type": "string",
"description": "longitude",
"example": "27.0238"
},
"loc": {
"type": "string",
"description": "location",
"example": "FORT"
},
"lt": {
"type": "string",
"description": "lattitude",
"example": "74.2179"
},
"pncd": {
"type": "string",
"description": "Pincode",
"example": "400001"
},
"st": {
"type": "string",
"description": "Street Name",
"example": "10, VEER NARIMAN ROAD"
},
"stcd": {
"type": "string",
"description": "State Name",
"example": "Rajasthan"
}
},
"type": "object"
},
"ntr": {
"items": {
"type": "string",
"description": "Nature of Additional place of business",
"example": " Wholesale Business"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"pradr": {
"properties": {
"addr": {
"properties": {
"bnm": {
"type": "string",
"description": "Building Name",
"example": "KATGARA HOUSE"
},
"bno": {
"type": "string",
"description": "Building Number",
"example": "5"
},
"flno": {
"type": "string",
"description": "Floor Number",
"example": "4TH FLOOR"
},
"lg": {
"type": "string",
"description": "longitude",
"example": "27.0238"
},
"loc": {
"type": "string",
"description": "Location",
"example": "MALABAR HILL"
},
"lt": {
"type": "string",
"description": "lattitude",
"example": "74.2179"
},
"pncd": {
"type": "string",
"description": "Pincode",
"example": "400006"
},
"st": {
"type": "string",
"description": "Street Name",
"example": " 15, L JAGMOHANDAS MARG"
},
"stcd": {
"type": "string",
"description": "State Name",
"example": "Maharashtra"
}
},
"type": "object"
},
"ntr": {
"items": {
"type": "string",
"description": "Nature of pricipal place of Business",
"example": " Wholesale Business"
},
"type": "array"
}
},
"type": "object"
},
"ctb": {
"type": "string",
"description": "Constitution of Business",
"example": "sole "
},
"ctj": {
"type": "string",
"description": "Center Jurisdiction",
"example": "Delhi"
},
"ctjCd": {
"type": "string",
"description": "Center Jurisdiction Code",
"example": "AP004"
},
"cxdt": {
"type": "string",
"description": "Date Of Cancellation",
"example": "NA"
},
"dty": {
"type": "string",
"description": "TaxPayer type",
"example": "Casual"
},
"gstin": {
"type": "string",
"description": "GST Identification Number",
"example": "27ASJPC0786C3C7"
},
"einvoiceStatus": {
"type": "string",
"description": "eInvoice enablement status for GSTIN",
"example": "Yes"
},
"lgnm": {
"type": "string",
"description": "Legal name of the business",
"example": "Vay Network Services Pvt Ltd"
},
"nba": {
"type": [
"array",
"null"
],
"description": "Nature of Business Activity",
"items": {
"type": "string"
},
"example": [
"Bonded Warehouse",
"Factory / Manufacturing",
"Input Service Distributor (ISD)",
"Office / Sale Office"
]
},
"rgdt": {
"type": "string",
"description": "Date of Registration",
"example": "5/5/2017"
},
"stj": {
"type": "string",
"description": "State Jurisdiction",
"example": "Karnataka"
},
"stjCd": {
"type": "string",
"description": "State Jurisdiction Code",
"example": "AP003"
},
"sts": {
"type": "string",
"description": "GSTN status",
"example": "Active"
},
"lstupdt": {
"type": "string",
"format": "Date",
"pattern": "DD/MM/YYYY",
"description": "Lst Updated Date",
"example": "5/1/2017"
},
"tradeNam": {
"type": "string",
"description": "trade Name",
"example": "GSTN"
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/gcs/bulk": {
"post": {
"tags": [
"Verification Suite"
],
"summary": "GCS Generate",
"description": "The Generate Good Compliance Score (GCS) API supports bulk score generation for multiple GSTINs (Max upto 50 GSTIN in single request). This is an asynchronous API and returns a `task-id` in the response upon successful submission. Use the returned task ID to track processing status via the [Status API](#/Support%20Suite/eas_enriched_v1_task_status). Once the task completes, retrieve the result using the [Get Result](#/Support%20Suite/eas_enriched_v1_result_task/example/0) API.\n\nA successful Get Result response is shown below:\n\n```json\n{\n \"status\": \"1\",\n \"data\": {\n \"gstin\": \"29AAACT2727Q1ZS\",\n \"score\": 462.5\n },\n \"error\": null,\n \"info\": null,\n \"additionalInfo\": null,\n \"alert\": null\n}\n```",
"operationId": "eas_enriched_v1_gcs_generate",
"_peer-api": "/enriched/gcs/v1.0/generate",
"parameters": [
{
"name": "X-ATLAS-ORG-ID",
"description": "Organization (ID) on behalf of which the request is made",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "ba4cf3fa-f0da-4764-b108-eca22098e7cb"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"gstins": {
"type": "array",
"items": {
"type": "string",
"minLength": 15,
"maxLength": 15,
"pattern": "([0-9]{2}[0-9A-Z]{13})",
"example": "26ABCMH0791G9ZI"
},
"example": [
"26ABCMH0791G9ZI",
"29AAACT2744Q1ZS"
]
}
},
"required": [
"gstins"
],
"example": {
"gstins": [
"26ABCMH0791G9ZI",
"29AAACT2744Q1ZS"
]
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"name": "X-ATLAS-CALL-ID",
"description": "A unique Identifier for your request",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"X-CALL-ID": {
"name": "X-CALL-ID",
"in": "header",
"required": true,
"description": "unique id",
"schema": {
"type": "string",
"example": "395b8578-7439-44e9-a51a-c5e23b8e01b5"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": [
"object"
],
"properties": {
"task-id": {
"type": "string",
"format": "uuid"
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"example": null,
"type": [
"object",
"null"
]
},
"additionalInfo": {
"example": null,
"type": [
"object",
"null"
],
"properties": {
"key": {
"type": [
"object",
"null"
]
},
"pdf": {
"type": [
"string",
"null"
]
},
"details": {
"type": [
"object",
"null"
]
}
}
},
"alert": {
"example": null,
"type": [
"string",
"null"
]
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status indicates positive(1) or error response(0)",
"enum": [
"0",
"1"
]
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null",
"example": "null"
},
"error": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "Authorization"
},
"message": {
"type": "string",
"example": "err-invalid-org"
},
"args": {
"type": [
"object",
"null"
]
}
}
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/gstin/{gstin}/returns-track/fy/{fy}": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "Get View And Track Returns",
"description": "View and Track Return API fetches public information on return filing of a particular GSTIN. You need to provide the financial year (FY) along with the GSTIN to fetch the results (return filings) done during that FY.",
"operationId": "eas_basic_v1_gstn_view_returns",
"_peer-api": "/basic/gstn/v3.0/commonapi/v1.0/returns?gstin=29HJKPS9689A8Z5&fy=2020-21&action=RETTRACK&type=R1",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1gstin~1%7Bgstin%7D/get/parameters/3"
},
{
"name": "gstin",
"required": true,
"schema": {
"type": "string",
"maxLength": 15,
"example": "29HJKPS9689A8Z5"
},
"description": "GSTIN to search",
"in": "path"
},
{
"name": "fy",
"required": true,
"schema": {
"type": "string",
"example": "2017-18"
},
"description": "format = YYYY-YY <br /> min-value = 2017-18 ",
"in": "path"
},
{
"name": "action",
"required": true,
"schema": {
"type": "string",
"example": "RETTRACK"
},
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"EFiledlist": {
"description": "List of Electronically filed returns",
"type": "array",
"items": {
"type": "object",
"properties": {
"valid": {
"type": "boolean",
"examples": true
},
"mof": {
"type": "string",
"examples": [
"ONLINE"
]
},
"dof": {
"type": "string",
"examples": [
"16-01-2018"
]
},
"ret_prd": {
"type": "string",
"examples": [
"062017"
]
},
"rtntype": {
"type": "string",
"examples": [
"GSTR3B"
]
},
"arn": {
"type": "string",
"examples": [
"AA080617000247D"
]
},
"status": {
"type": "string",
"examples": [
"Filed"
]
}
}
}
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
# --- truncated at 32 KB (749 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vayana-network/refs/heads/main/openapi/vayana-network-atlas-openapi.json