Skip to content

Unregistered Applicants API Details#

This API Service is used to fetch the details of the URD for e-commerce supplier

Route

/basic/gstn/{flynn-version}/commonapi/{gstn-api-version}/unregistered-applicants?action={action}&uid={uid}

  • active ‘flynn-version’: v1.0
  • method: GET

URL Parameters#

Name Description Type
flynn-version version of the API
for example, v1.0		 string
gstn-api-version as per the version of the GST API Documentation
for example, v1.0		 string

QUERY Parameters#

Name Description Type
uid UID of the Unregistered Applicants
for example, 292200000001ES9		 string
action Api action
for example, TP		 string

Headers#

All required headers to make an authenticated API call.

Apart from the common headers need to pass below headers

header Description
X-FLYNN-N-GSTIN Valid GST Identification Number
for example, 33GSPTN0791G1Z5
X-FLYNN-N-GSTN-GSP-CODE vay

Response#

200#

Successful response will be the same payload as per the ‘GST API Documentation’ for the “Unregistered Applicants” API.

Sample Response Body

{
  "status": "1",
  "data": {
    "name": "Vay Network",
    "pan": "ABCFP2884S",
    "state": "Tamil Nadu",
    "addtls": {
      "bno": "3/1-10",
      "bnm": "",
      "st": "3rd Street",
      "loc": "West Mambalam",
      "pncd": "600033",
      "stcd": "Tamil Nadu",
      "lg": "13.035805",
      "lt": "80.2204520000001",
      "dst": "Chennai",
      "cnty": "IND",
      "landMark": "West Mambalam Sub Post Office",
      "city": "Chennai"
    },
    "goodsdetails": "",
    "servicedetails": ""
  },
  "error": null,
  "info": null,
  "additionalInfo": null,
  "alert": null
}
Errors#

Invalid UID

{
    "status": "0",
    "data": null,
    "error": {
        "message": "err-gstn-returned-error",
        "type": "Gstn",
        "args": {
            "details": [
                {
                    "ErrorCode": "FO8009",
                    "ErrorMessage": "The UID passed in the request is invalid."
                }
            ]
        }
    },
    "info": null,
    "additionalInfo": null,
    "alert": null
}

GSTN Error

{
    "status": "0",
    "data": null,
    "error": {
        "message": "err-gstn-returned-error",
        "type": "Gstn",
        "args": {
            "details": [
                {
                    "ErrorCode": "FO8010",
                    "ErrorMessage": "No Data found."
                }
            ]
        }
    },
    "info": null,
    "additionalInfo": null,
    "alert": null
}

Client Error

{
    "status": "0",
    "data": null,
    "error": {
        "message": "err-param-is-mandatory",
        "type": "ClientRequest",
        "args": {
            "parameter-name": "uid"
        }
    },
    "info": null,
    "additionalInfo": null,
    "alert": null
}
Response Status Description
400 Invalid GSTN API Version
502 Error at GSTN end

Common Errors

check here for other common errors.