AddressValidationRequest Elements

Element Required Description
AddressValidationRequest/ RequestTimestamp Required Time of request based on shipper’s time zone. Defaults to CDT.

The date format must be YYYY-MM-DDTHH:MM:SS-xx:xx. The time must be in the format: HH:MM:SS using a 24-hour clock. The date and time are separated by the letter T (e.g., 2009-06-26T17:00:00). The UTC offset indicates the number of hours/minutes (e.g. xx:xx) from UTC (e.g. 2009-06-26T17:00:00-04:00 is defined as June 26, 2009 5:00 p.m. Eastern Time).

SeeTime Zones for more information.

AddressValidationRequest/ AddressToValidate Required This element contains basic address information for validation, including:
  • Company
  • City
  • StateorProvinceCode
  • PostalCode
  • UrbanizationCode
  • CountryCode
  • Residential
Note: Up to 100 addresses can be validated in one request.
AddressValidationRequest/ AddressValidationOptions Optional In addition to address information, you can include the following elements to further identify the type of address validation information or formatting you want in the reply:

VerifyAddresses to validate all address elements and return in the reply.

CheckResidentialStatus check addresses for residential status only.

MaximumNumberOfMatches allows you to configure the number of possible matches returned. Maximum is 10.

StreetAccuracy: Values are: EXACT, TIGHT, MEDIUM, and LOOSE.

DirectionalAccuracy: Values are EXACT, TIGHT, MEDIUM and LOOSE.

CompanyNameAccuracy: Values are EXACT, TIGHT, MEDIUM and LOOSE.

For U.S. addresses only, you can control the algorithm to use when determining if an input address matches an address in the postal database. Valid values are:

  • EXACT: input must match the database exactly.
  • TIGHT: matching of address is allowed for slight variance
  • MEDIUM: matching of address allows for more variance of address and provides corrections [default]
  • LOOSE: matching of address is minimal

Warning: Selecting EXACT means that every part of the address must match the postal database exactly, and no correction will be made to the address for you.

It is recommended to use the MEDIUM setting to get better results.

ConvertToUpperCase element controls whether addresses are returned in upper case text.

RecognizeAlternateCityNames recognizes alternate city names. For example, if you have an address whose city is Hollywood, if the address can be verified as in Los Angeles, address verification will be performed instead of returning an error.

ReturnParsedElements returns the address validation elements in the reply, as verified by the system before validation.