Address Output
The address may be identical to the input address if the input address was accurate, or it may be a standardized version of the input address, or it may be a candidate address when multiple matches are found.
Response Element |
Description |
---|---|
AddressLine1 |
First line of the address. |
AddressLine2 |
Second line of the address. |
ApartmentLabel |
The type of unit, such as apartment, suite, or lot. |
ApartmentLabel.Input |
The type of unit, such as apartment, suite, or lot as it was input. |
ApartmentNumber |
Unit number. |
ApartmentNumber.Input |
Unit number as it was input |
City |
The name. |
City.Input |
The name as it was input. For Japan, the municipality subdivision (sub-city) |
Country |
The three-letter ISO 3166-1 Alpha 3 country code. For Angola, the country code is AGO. For Burundi, the country code is BDI. For Benin, the country code is BEN. For Burkina Faso, the country code is BFA. For Botswana, the country code is BWA. For Cameroon, the country code is CMR. For Democratic Republic of Congo, the country code is COD. For Congo, the country code is COG. For Gabon, the country code is GAB. For Ghana, the country code is GHA. For Kenya, the country code is KEN. For Lesotho, the country code is LSO. For Morocco, the country code is MAR. For Mali, the country code is MLI. For Mozambique, the country code is MOZ. For Mauritania, the country code is MRT. For Mauritius, the country code is MUS. For Malawi, the country code is MWI. For Namibia, the country code is NAM. For Niger, the country code is NER. For Nigeria, the country code is NGA. For Rwanda, the country code is RWA. For Senegal, the country code is SEN. For Swaziland, the country code is SWZ. For Togo, the country code is TGO. For Tunisia, the country code is TUN. For Tanzania, the country code is TZA. For Zambia the country code is ZMB. For Zimbabwe the country code is ZWE. Addresses for countries that do not have a dedicated geocoding stage return the country code associated with the input address. For example, Vatican City addresses return VAT in the Country field, regardless of whether VAT or ITA (Italy) was passed as the country code. Similarly, addresses in Martinique return MTQ (rather than FRA) in the Country field. |
Country.Input |
The three-letter ISO 3166-1 Alpha 3 country code as it was input. For Angola, the country code is AGO. For Burundi, the country code is BDI. For Benin, the country code is BEN. For Burkina Faso, the country code is BFA. For Botswana, the country code is BWA. For Cameroon, the country code is CMR. For Democratic Republic of Congo, the country code is COD. For Congo, the country code is COG. For Gabon, the country code is GAB. For Ghana, the country code is GHA. For Kenya, the country code is KEN. For Lesotho, the country code is LSO. For Morocco, the country code is MAR. For Mali, the country code is MLI. For Mozambique, the country code is MOZ. For Mauritania, the country code is MRT. For Mauritius, the country code is MUS. For Malawi, the country code is MWI. For Namibia, the country code is NAM. For Niger, the country code is NER. For Nigeria, the country code is NGA. For Rwanda, the country code is RWA. For Senegal, the country code is SEN. For Swaziland, the country code is SWZ. For Togo, the country code is TGO. For Tunisia, the country code is TUN. For Tanzania, the country code is TZA. For Zambia the country code is ZMB. For Zimbabwe the country code is ZWE. Addresses for countries that do not have a dedicated geocoding stage return the country code associated with the input address. For example, Vatican City addresses return VAT in the Country field, regardless of whether VAT or ITA (Italy) was passed as the country code. Similarly, addresses in Martinique return MTQ (rather than FRA) in the Country field. |
County |
The meaning of county varies by country. The majority of countries in the Africa database (XA1) do not use a county or equivalent as part of an address.
This field is not used with countries included with the Africa bundle (Product Code XA1). These African countries generally have less comprehensive address coverage. |
FirmName |
Name of the company or a place name. |
FirmName.Input |
Name of the company or a place name as it was input. |
FormattedInputStreet.Input |
The street as it was input. |
Geocoder.MatchCode |
|
HouseNumber |
The number for the matched location. |
HouseNumber.Input |
The number for the matched location as it was input |
HouseNumberHigh |
The highest house number of the range in which the address resides. |
HouseNumberLow |
The lowest house number of the range in which the address resides. |
HouseNumberParity |
Indicates if the house number range contains even or odd numbers or both.
|
IntersectionIdStreet2.Input |
The second street in an intersection address as it was input. |
IsCloseMatch |
Indicates whether candidate is a close match. |
Language |
For reverse geocoded candidates, the two-character language code is returned. |
LastLine |
Complete last address line (city, state/province, and postal code). |
Latitude |
Latitude of the candidate. |
LeadingDirectional |
Street directional that precedes the street name. For example, the N in 138 N Main Street. |
LeadingDirectional.Input |
Street directional that precedes the street name as it was input. |
Locality |
The meaning of locality varies by country. Generally a locality is a village in rural areas or it may be a suburb in urban areas. When used, a locality typically appears on the last line of the address with the postcode. African and Middle East countries do not use a locality or equivalent as part of an address. However there is no penalty if state/province is used in input address.
|
Locality.Input |
The locality as it was input.
|
Longitude |
Longitude of the candidate. |
NumberOfCandidateRanges |
Indicates the number of ranges of which the candidate is a member. A candidate may be a part of multiple ranges if the candidate is a street instead of a building. To specify the number of ranges to return for each candidate, use the MaxRanges option. |
NumberOfRangeUnits |
Indicates the number of units included in the range. A unit is an address within a building, such as an apartment or office suite. |
PostalCode |
The postal code for the address. The format of the postcode varies by country. Postcode data is not available for every country. |
PostalCode.Addon |
The second part of a postcode. This field is not used by most countries. |
PostalCode.Addon.Input |
The second part of a postcode as it was input. This field is not used by most countries. |
PostalCode.Base |
The first part of a postcode. This field is not used by most countries. |
PostalCode.Base.Input |
The first part of a postcode. This field is not used by most countries. |
PreAddress |
Miscellaneous information that appears before the street name. |
PrivateMailbox |
This field is not currently used. |
Ranges |
This is a list field containing the address ranges that exist on the street segment where the candidate address is located. A range is a series of addresses along a street segment. For example, 5400-5499 Main St. is an address range representing addresses in the 5400 block of Main St. A range may represent just odd or even addresses within a segment, or both odd and even addresses. A range may also represent a single building with multiple units, such as an apartment building. The Ranges field contains the following sub-fields: |
|
|
|
|
|
|
|
|
SegmentCode |
A unique ID that identifies . |
SegmentParity |
Indicates which side of the street has odd numbers.
|
StateProvince |
The meaning of State/Province varies by country. Countries in the Africa, Middle East, and Latin America databases do not use a state/province or equivalent as part of an address. However there is no penalty if state/province is used in input address.
|
StreetDataType |
The default search order rank of the database used to geocode the address. A value of "1" indicates that the database is first in the default search order, "2" indicates that the database is second in the default search order, and so on. The default database search order is specified in the Management Console. |
StreetName |
For most countries, this contains the street name. |
StreetPrefix |
The type of street when the street type appears before the base street name. |
StreetSuffix |
The type of street when the street type appears after the base street name. |
TrailingDirectional |
Street directional that follows the street name. |
UnitNumberHigh |
The highest unit number of the range in which the unit resides. |
UnitNumberLow |
The lowest unit number of the range in which the unit resides. |
Return Parsed Address | The formatted input address can be returned along with a separate returned field for each input address element. Parsed Address Input elements are returned in separately labeled fields names with a .Input extension. See Result Codes |