Parameters for Input Data
ValidateAddress 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. addresses.
Parameter |
Format |
Description |
---|---|---|
AddressLine1 |
String [50] |
The first address line. |
AddressLine2 |
String [50] |
The second address line. |
AddressLine3 |
String [50] |
The third address line. Does not apply to Canadian addresses. |
AddressLine4 |
String [50] |
The fourth address line. Does not apply to Canadian addresses. |
AddressLine5 |
String [50] |
The fifth address line. Applies only to U.K. addresses. May contain street name, unit number, building number, and so on. |
City |
String [50] |
The city name. For U.S. 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. |
StateProvince |
String [50] |
The state or province. For U.S. addresses only, you may put the state in the City field instead of the StateProvince field. |
PostalCode |
String [10] |
The postal code for the address in one of the following formats: 99999 For U.S. addresses only, you may put the ZIP Code™ in the City field. For U.S. addresses only, if the city/state/ZIP Code™ is in the PostalCode field, ValidateAddress may parse the data and successfully process the address. For best results, put this data in the appropriate fields (City, StateProvince, and PostalCode). |
Country |
String [50] |
The country code or name, in any of the following formats:
For a list of ISO codes, see ISO Country Codes and Module Support. |
FirmName |
String [50] |
The company or firm name. |
USUrbanName |
String [50] |
The U.S. address urbanization name. This is used primarily for Puerto Rico addresses. |
CustomerID |
String [9] |
If this mailpiece uses a generic barcode, specify your USPS®-assigned customer ID in this field. The ValidateAddress generic barcode is used for mailpieces that use the OneCode ACS® service. |
CanLanguage |
String |
For Canadian addresses only, indicates whether the address is in English or French, if the 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. |