Fetch address details with the Address autocomplete Fetch API

Learn more about how to use the Address autocomplete Fetch API to retrieve full address details for a selected address identifier.

Use the Address autocomplete Fetch to retrieve the full details of an address from its unique identifier. This operation is typically called after an address suggestion is selected from the Search API response. For more information, see Address autocomplete.

HTTP method and endpoint

Use the following HTTP method and endpoint path to submit the request:

GET {TenantURL}/address/fetch

Replace {TenantURL} with your tenant base URL.

Request headers

Include the following headers in each request:


Name	Required	Description
`Authorization`	Yes	Bearer access token in the format `Bearer <accessToken>`. For authentication details, see Authentication API.
`Content-Type`	Yes	Set to `application/json`.

Query parameters

The following table describes the supported query parameters.


Name	Type	Required	Description
`ID`	String	Yes	Unique address identifier returned by the Search API.

Request body

This operation does not require a request body.

Example request

The following example fetches the details for a selected address identifier:

GET {TenantURL}/address/fetch?ID=IN%7CLP%7CB%7C14161031%7C_ENG
Authorization: Bearer <accessToken>
Content-Type: application/json

Example response

The following example shows the response returned by the API:

[
  {
    "Id": "IN|LP|B|55231200|_ENG",
    "DomesticId": "55231200",
    "Language": "ENG",
    "LanguageAlternatives": "ENG,HIN,KAN",
    "Company": "Reltio",
    "Neighbourhood": "AMR Tech Park",
    "District": "Hongasandra",
    "City": "Bengaluru",
    "Line1": "Hongasandra",
    "AdminAreaName": "Bengaluru District",
    "Province": "KA",
    "ProvinceName": "Karnataka",
    "ProvinceCode": "KA",
    "PostalCode": "560068",
    "CountryName": "India",
    "CountryIso2": "IN",
    "CountryIso3": "IND",
    "CountryIsoNumber": "356",
    "Label": "Reltio\n\nBengaluru\n560068\nINDIA",
    "Type": "Unknown",
    "DataLevel": "Premise"
  }
]

Response fields

The following table describes the fields shown in the sample response.


Field	Type	Description
`Id`	String	Unique identifier of the returned address.
`DomesticId`	String	Unique reference number of the address in the provider dataset.
`Language`	String	Language code of the returned address.
`LanguageAlternatives`	String	Comma-separated list of alternative language versions.
`Company`	String	Company name associated with the address.
`Neighbourhood`	String	Neighbourhood of the address.
`District`	String	District name.
`City`	String	Town or city name.
`Line1`	String	First line of the formatted address.
`AdminAreaName`	String	Name of the administrative area.
`Province`	String	Province value returned for the address format.
`ProvinceName`	String	Name of the administrative division.
`ProvinceCode`	String	Code of the administrative division.
`PostalCode`	String	Postal code.
`CountryName`	String	Full country name.
`CountryIso2`	String	Two-character country code.
`CountryIso3`	String	Three-character country code.
`CountryIsoNumber`	String	Numeric country code.
`Label`	String	Formatted address label.
`Type`	String	Returned address type.
`DataLevel`	String	Granularity level of the returned address data.

Unify and manage your data