The AddressElements property of the Results object contains the following elements:
Building
Contains building information. A Building field contains building-level data, such as the building descriptor, building name, and building number.
The Building element includes the following properties:
Value. The building information.
SubItems. The sub-items of the element. The possible values are PreDescriptor, Name, Number, and PostDescriptor.
Status. The address element status codes.
SubBuilding
Contains sub-building information, such as an apartment or suite number. A SubBuilding field contains sub-building level data, such as the sub-building descriptor, sub-building name, and sub-building number.
The SubBuilding element includes the following properties:
Value. The sub-building information.
SubItems. The sub-items of the element. The possible values are PreDescriptor, Name, Number, and PostDescriptor
Status. The address element status codes.
Street
Contains street information. A Street field contains street-level data, such as the street name, street post-descriptor, street post-directional, street pre-descriptor, and street pre-directional.
The Street element includes the following properties:
Value. The street information.
SubItems. The sub-items of the element. The possible values are , PreDescriptor, PreDirectional, Name, Number, PostDirectional, PostDescriptor, and AdditionalInfo.
Status. The address element status codes.
SupplementaryDeliveryInformation
Contains supplementary delivery information. A SupplementaryDeliveryInformation field adds supplementary data to an address to assist the mail carrier in mail delivery.
The SupplementaryDeliveryInformation element includes the following properties:
Value. The supplementary delivery information.
Status. The address element status codes.
HouseNumber
Contains house number information. The house number identifies a building at street level.
The HouseNumber element includes the following properties:
Value. The house number information.
SubItems. The sub-items of the element. The possible values are PreDescriptor, Number, Suffix, and PostDescriptor.
Status. The address element status codes.
DeliveryService
Contains delivery service information. A delivery service is a mail pickup location managed by the post office, such as a P.O. Box.
The DeliveryService element includes the following properties:
Value. The delivery service information.
SubItems. The sub-items of the element. The possible values are PreDescriptor, Number, NumberSuffix, PostDescriptor, and AdditionalInfo.
Status. The address element status codes.
PostOffice
Contains post office information.
The PostOffice element includes the following properties:
Value. The post office information.
SubItems. The sub-items of the element. The possible values are PreDescriptor, Name, Number, PostDescriptor, and AdditionalInfo.
Status. The address element status codes.
Locality
Contains locality information.
The Locality element includes the following properties:
Value. The locality information.
SubItems. The sub-items of the element. The possible values are Prefix, Name, Suffix, SortingCode, and AdditionalInfo.
Status. The address element status codes.
PostalCode
Contains postal code information.
The PostalCode element includes the following properties:
Value. The postal code information.
SubItems. The sub-items of the element. The possible values are Base and AddOn.
Status. The address element status codes.
AdministrativeDivision
Contains province information.
The AdministrativeDivision element includes the following properties:
Value. The province information.
Variants. The variants of the element. The possible values are Extended, ISO, and Abbreviation.
SubItems. The sub-items of the element. The possible values are Prefix, Name, and Suffix.
Status. The address element status codes.
Residue
Contains residue information. A Residue field contains data duplicate or redundant data.
The Residue element includes the following properties:
Value. The residue information.
Type. The type of residue information. The possible values are Necessary, Superfluous, and Unrecognized.
Country
Contains country information.
The Country element includes the following properties:
Code. The ISO2, ISO3, or the ISONumber of the country.
Name. The name of the country, such as ENG.
The CountryNameLanguage and CountryCodeType properties present in the Standardizations element controls the country name and the country code.
By default, Address Verification does not return sub-item data or variant data for address elements. Some properties of
CountrySets
in the AVJob.schema.json file determine whether Address Verification returns the data. To return sub-item data or variant data in an output address, set the