This type is used as a parameter in the VerifyAddressAdvanced
method. The Return*
properties are optional and available for U.S. addresses only. When verifying Canadian addresses, optional parameters that are set to True
will return null values.
Type Properties
Property Name | Description | Data Type | Sample |
---|---|---|---|
CityName | City name. | String | Chesapeake |
FirmOrRecipient | Firm or recipient. | String | Esendex |
LicenseKey | Your license key. | String | 00000000-0000-0000-0000-000000000000 |
PrimaryAddressLine | Primary address line (address number and street name). | String | 505 Independence Parkway |
ReturnCaseSensitive | Set to true to DISABLE the default behavior of returning the street name in ALL CAPS. | Boolean | True |
ReturnCensusInfo | Set to true to include CensusInfo in the response. | Boolean | True |
ReturnCityAbbreviation | Set to true to return the abbreviated city name in the response. | Boolean | True |
ReturnGeoLocation | Set to true to include GeoLocationInfo in the response. | Boolean | True |
ReturnLegislativeInfo | Set to true to include LegislativeInfo in the response. | Boolean | True |
ReturnMailingIndustryInfo | Set to true to include MailingIndustryInfo in the response. | Boolean | True |
ReturnResidentialIndicator | Set to true to include ResidentialDeliveryIndicator in the response. | Boolean | True |
ReturnStreetAbbreviation | Set to true to return the abbreviated street name (if available). | Boolean | True |
SecondaryAddressLine | Secondary address line. | String | Suite 300 |
State | State. | String | VA |
Urbanization | Urbanization name (used in Puerto Rico only). | String | BOSQUE DE LAS FLORES |
ZipCode | ZIP code. | String | 23320 |