Skip to content

Get Address by GSTIN#

Get Address by GSTIN API is used to get an Address using the given GSTIN.

Route

invxb/apis/{banners-version}/orgs/{org-id}/addresses/addressbygstin/{GSTIN}

- active 'banners-version': v1
- method: GET

URL Parameters#

Name Description Type
banners-version version of the API
for example, v1		 string
org-id theodore organisation id string
GSTIN GSTIN linked with Address
for example, 27AABBB1122CZ10		 string

Response#

Successful response will have the response in “data” attribute as a json.

200#

Sample response body

{
  "data": {
    "status": "1",
    "data": {
      "id": "9f7fd6f1-91e8-46da-a050-2e91fd2711fe",
      "identifier": "38AABBB1120CZ10",
      "gstService": "einvoice",
      "emailEndpoints": "abc@def.com",
      "restEndpoint": null,
      "registeredByOrg": {
        "id": "0d1c5ac7-3fdd-495c-ac19-196d7337d491",
        "name": "Organisation A LLP",
        "taxIdentifier": "ORGAA1234K",
        "taxIdentifierType": "PAN",
        "country": "India",
        "tz": "Asia/Kolkata",
        "locale": "en_US"
      },
      "publicKey": null,
      "createdOn": 1662804184621,
      "lastUpdated": 1662804184621
    },
    "errors": null,
    "infoDetails": null
  }
}

In case there is no address for the given GSTIN, failure response will look as follows -

400 BAD REQUEST#

Sample Response Body

{
    "error": {
        "message": "err-reading-from-db",
        "type": "DbError",
        "args": {
            "table": "irba_addresses",
            "db-err": "err-address-not-defined",
            "err-type": "FetchError"
        }
    }
}
Last update: September 10, 2022