Parameters for Input Data
ValidateMailingAddressUSCAN takes an address as input. All addresses use this format regardless of the address's country. See Address Line Processing for U.S. Addresses for important information about how address line data is processed for U.S. and Canada addresses.
Parameter |
Format |
Description |
---|---|---|
Data.AddressLine1 |
String [50] |
The first address line. |
Data.AddressLine2 |
String [50] |
The second address line. |
Data.City |
String [50] |
The city name. For U.S. and Canada addresses only, you may put the city, state, and ZIP Code™ in the City field. If you do this, you must leave the StateProvince and PostalCode fields blank. |
Data.StateProvince |
String [50] |
The state or province. For U.S. and Canada addresses only, you may put the state in the City field instead of the StateProvince field. |
Data.PostalCode |
String [10] |
The postal code for the address in one of the following formats: 99999 For U.S. and Canada addresses only, you may put the ZIP Code™ in the City field. For U.S. and Canada addresses only, if the city/state/ZIP Code™ is in the PostalCode field, ValidateMailingAddressUSCAN may parse the data and successfully process the address. For best results, put this data in the appropriate fields (City, StateProvince, and PostalCode). |
Data.Country |
String [50] |
The country code or name, in any of the following formats:
The ISO codes are as follows:
|
Data.FirmName |
String [50] |
The company or firm name. |
Data.USUrbanName |
String [50] |
The U.S. address urbanization name. This is used primarily for Puerto Rico addresses. |
Data.CanLanguage |
String |
For Canadian addresses only, indicates whether the address is in English or French, if the option Option.CanFrenchFormat=T is used. If this field is blank, the address is formatted in English. If the field contains any non-blank value, the address is formatted in French. Note that addresses in Quebec are always formatted in French regardless of the value in this field. |
Data.InstanceKey |
String |
The key used with GlobalTypeAhead services. |