Skip to content

Get Address by PAN#

Get Address by PAN API is used to get an Address using the given PAN and Gst Service.

Route

invxb/apis/{banners-version}/orgs/{org-id}/addresses/addressbypan/{PAN}/{GstService}

- 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
PAN Permanent Account Number linked with Address
for example, AABBB1122C
string
GstService GstService selected while registering the Address
for example, EINVOICE
string

Response#

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

200#

Sample response body

{
  "data": {
    "status": "1",
    "data": [
      {
        "itemStatus": "1",
        "itemData": {
          "id": "04e28a83-4c71-40b5-a150-29048370cd32",
          "identifier": "38AABBB1120CZ2O",
          "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": 1662804665266,
          "lastUpdated": 1662804665266
        },
        "itemErrors": null,
        "itemInfoDetails": null
      },
      {
        "itemStatus": "1",
        "itemData": {
          "id": "78d9463d-b9df-41f2-aa37-69622e805aa3",
          "identifier": "38AABBB1120CZ1O",
          "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": 1662804665237,
          "lastUpdated": 1662804665237
        },
        "itemErrors": null,
        "itemInfoDetails": null
      },
      {
        "itemStatus": "1",
        "itemData": {
          "id": "7ba7c0b6-a59d-4625-8290-0c07636ed1a0",
          "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": 1662804665556,
          "lastUpdated": 1662804665556
        },
        "itemErrors": null,
        "itemInfoDetails": null
      }
    ],
    "errors": null,
    "infoDetails": null
  }
}

Last update: September 10, 2022