AC – Address Response

Address Object for Addresses

In the following code block we can see that “address” is a parameter passed into the function when the populate event is detected. Additional logic can be added in this function, for example, and can help deal with any additional business logic that is needed to be implemented.

Listen for Events Example

DOTSGlobalAddressComplete.listen("populate", function(address, variations) {
    document.getElementById("LabelJSON").innerText = address.FormattedAddress.toUpperCase();
});

Address

Field	Type	Description	USA Only
AddressStatus	String	The status of a US address “Address Verified”, “Premise Number Unknown”, …	*
Language	String	Language of returned address.
LanguageAlternatives	String	Available alternative languages for the results.
BusinessName	String	Name of business associated with this address. Provided when possible.
SubPremise	String	Unit/Apt/Suite…
PremiseNumber	String	Street number.
PremiseName	String	Building name.
StreetName	String	The name of the street.
StreetLine	String	The name of the street and street suffix.
Locality	String	The name of the distinct population cluster, such as a City, Town or other type of Municipality.
Address1	String	Address Line 1 of the Address.
Address2	String	Address Line 2 of the Address.
Address3	String	Address Line 3 of the Address.
Address4	String	Address Line 4 of the Address.
Address5	String	Address Line 5 of the Address.
AdminArea	String	The name of the administrative division. Commonly the primary division of a country, such as a State, Region, Province, County, Territory or Prefecture.
AdminAreaCode	String	Usually the abbreviation of AdminArea.
PostalCode	String	The postal code of the address. It is recommended that the postal code be formatted to contain a strong resemblance to the proper country specific format, and that you do not precede the postal code with a country or region code. For example, use ‘09170’ instead of ‘FR-9170’.
Country	String	Country of the selected address.
CountryISO2	String	The ISO 3166-1 Alpha-2 Country Code of the country associated to the address selected.
CountryISO3	String	The ISO 3166-1 Alpha-3 Country Code of the country associated to the address selected.
POBox	String	Indicate if the address is a PO Box.
FormattedAddress	String	Standardized complete address.
AddressType	String	The type of the address, such as Commercial, Residential, Unknown. *USA, Canada and UK ONLY
ResolutionLevel	String	The resolution level of the address returned, such as Premise, Street, Range
BarcodeDigits	Integer	The post office delivery barcode digits. Barcode Example: 931011445011	*
CarrierRoute	String	4 chars: 1 for the route type, 3 for the route code. Identifies a group of addresses when prepended by 5-digit Zip.	*
CountyName	String	The name of the county in which the given address lies.	*
CountyCode	String	The county code of the given address.	*
CongressCode	String	The congress code is the congressional district number.	*
DPV	String	Number that correlates to a DPV(Delivery Point Validation) result. An indicator displaying whether or not the address is recognized as deliverable by the USPS.	*
DPVDesc	String	Explains DPV result.	*
AddressNotes	String	Number that correlates to DPV notes description. Service Objects may add or change Note descriptions, but will never modify existing codes.	*
AddressNotesDesc	String	Details about the DPV result. Service Objects may add or change Note descriptions, but will never modify existing codes.	*
Corrections	String	Number that correlates to a Corrections Description. Service Objects may add or change Correction descriptions, but will never modify existing codes.	*
CorrectionsDesc	String	Description of what was corrected in an address. Service Objects may add or change Correction descriptions, but will never modify existing codes.	*
StreetPreDirectional	String	The parsed pre-directional of the address’s street. “North” in 123 North Main St West Apt A	*
StreetPostDirectional	String	The parsed post-directional of the address’s street. “West” in 123 North Main St West Apt A	*
StreetSuffix	String	The parsed suffix of the street in the given address. “St” in 123 North Main St West Apt A	*

Address Type – Supported Countries

Canada

United Kingdom

United States