Options

The following table lists the options that control the type of information returned by ValidateAddress Loqate.

Table 1. Output Data Options
Parameter	Description
Option.Database.Loqate	Specifies which database you want to use for validating international addresses. To specify a database for international address validation, select a database in the Database drop-down list.
Option.OutputFieldLevelReturnCodes	Specifies whether to include field-level result indicators. Field-level result indicators describe how ValidateAddressLoqate handled each address element. Field-level result indicators are returned in the qualifier "Result". For example, the field-level result indicator for HouseNumber is contained in HouseNumber.Result. For a complete listing of result indicator output fields, see Result Indicators. N No, do not output field-level return codes (default). Y Yes, output field-level return codes.
Option.OutputFormattedOnFail	Specifies whether to return a formatted address when an address cannot be validated. The address is formatted using the preferred address format for the address's country. If this option is not selected, the output address fields are blank when ValidateAddressLoqate cannot validate the address. N No, do not format failed addresses (default). Y Yes, format failed addresses. Formatted addresses are returned using the format specified by the Include a standard address, Include address line elements, and Include postal information check boxes. Note that if you select Include address line elements, the parsed address elements will contain the parsed, validated address for addresses that could be validated. If the address could not be validated the parsed address elements will contain the input address in parsed form. If you always want the output to contain the input address in parsed form, regardless of whether or not ValidateAddressLoqate could validate the address, select Include standardized input address elements. If you check this option, you must select Include a standard address and/or Include address line elements. Formatted addresses are returned using the format specified by the OutputRecordType option. Note that if you specify OutputRecordType=E, the parsed address elements will contain the parsed, validated address for addresses that could be validated. If the address could not be validated the parsed address elements will contain the input address in parsed form. If you always want the output to contain the input address in parsed form, regardless of whether or not ValidateAddressLoqate could validate the address, specify OutputRecordType=I. If you specify Y, you must specify "A" and/or "E" for OutputRecordType. Formatted addresses are returned using the format specified by the Option.OutputRecordType option. Note that if you specify Option.OutputRecordType=E, the parsed address elements will contain the parsed, validated address for addresses that could be validated. If the address could not be validated the parsed address elements will contain the input address in parsed form. If you always want the output to contain the input address in parsed form, regardless of whether or not ValidateAddressLoqate could validate the address, specify Option.OutputRecordType=I. If you specify Y, you must specify "A" and/or "E" for Option.OutputRecordType.
Option.OutputAddressBlocks	Specifies whether to return a formatted version of the address as it would be printed on a physical mailpiece. Each line of the address is returned in a separate address block field. There can be up to nine address block output fields: AddressBlock1 through AddressBlock9. For example, this input address: AddressLine1: 4200 Parliament Place AddressLine2: Suite 600 City: Lanham StateProvince: MD PostalCode: 20706 Results in this address block output: AddressBlock1: 4200 PARLIAMENT PL STE 600 AddressBlock2: LANHAM MD 20706-1882 AddressBlock3: UNITED STATES OF AMERICA ValidateAddressLoqate formats the address into address blocks using postal authority standards. The country name is returned using the Universal Postal Union country name. Note that the option does not affect the country name in the address block, it only affects the name returned in the Country output field. One of the following: N No, do not return address blocks. Default. Y Yes, return address blocks.
Option.AmasFormatting	Specifies that output address data is to be formatted using Address Matching Approval System (AMAS) conventions. This option causes Validate Address Loqate to use AMAS rules when standardizing an address. AMAS is an Australia Post program for enforcing addressing standards. For more information on the AMAS formatting conventions, refer to the Address Matching Approval System (AMAS) Handbook. This option modifies the output data as follows. Numeric fields are padded with zeros. This affects the following output fields: HouseNumber, HouseNumber2, PostalDeliveryNumber, and DPID. For example, if the input address is 298 New South Head Rd Double Bay NSW 2028, then the format of the HouseNumber field is changed from 298 to 00298. If a match is not made, then all digits in the DPID field will be zero. For example, 00000000. If a match is not made, then all return fields (parsed address elements) will be blank, except numeric fields which will contain all zeros. The CCD field is not output. Valid values are: N No, do not format the output data using AMAS conventions (default). Y Yes, format the output data using AMAS conventions. Note: When this option is selected, results will be returned with AMAS formatting regardless of selections made in the Acceptance level and Minimum match score fields.
Option.OutputCasing	Specifies the casing of the output data. One of the following: M Returns the output in mixed case (default). For example: 123 Main St Mytown FL 12345 U Returns the output in upper case. For example: 123 MAIN ST MYTOWN FL 12345
Option.HomeCountry	Specifies the default country. You should specify the country where most of your addresses reside. For example, if most of the addresses you process are in Germany, specify Germany. ValidateAddressLoqate uses the country you specify to attempt validation when it cannot determine the country from the StateProvince, PostalCode, and Country address fields. The valid country names are: Afghanistan, Albania, Algeria, American Somoa, Andorra, Angola, Anguilla, Antigua And Barbuda, Argentina, Armenia, Aruba, Australia, Austria, Azerbaijan, Bahamas, Bahrain, Bangladesh, Barbados, Belarus, Belgium, Belize, Benin, Bermuda, Bhutan, Bolivia, Bosnia And Herzegovina, Botswana, Brazil, British Virgin Islands, Brunei Darussalam, Bulgaria, Burkina Faso, Burundi, Cambodia, Cameroon, Canada, Cape Verde, Cayman Islands, Central African Republic, Chad, Chile, China, Colombia, Comoros Islands, Congo, Cook Islands, Costa Rica, Cote D'Ivoire, Croatia, Cuba, Cyprus, Czech Republic, Democratic Republic Of Congo, Denmark, Djibouti, Dominica, Dominican Republic, East Timor, Ecuador, Egypt, El Salvador, Equitorial Guinea, Eritrea, Estonia, Ethiopia, Falkland Islands, Faroe Islands, Federated States Of Micronesia, Fiji, Finland, France, French Guiana, Gabon, Gambia, Germany, Ghana, Gibraltar, Greece, Greenland, Grenada, Guadeloupe, Guam, Guatemala, Guinea, Guinea Bissau, Guyana, Haiti, Holy See, Honduras, Hong Kong, Hungary, Iceland, India, Indonesia, Iran, Iraq, Ireland, Israel, Italy, Jamaica, Japan, Jordan, Kazakhstan, Kenya, Kiribati, Korea, Kuwait, Kyrgyzstan, Laos, Latvia, Lebanon, Lesotho, Liberia, Libya, Liechtenstein, Lithuania, Luxembourg, Macau, Macedonia, Madagascar, Malawi, Malaysia, Maldives, Mali, Malta, Marshall Islands, Martinique, Mauritania, Mauritius, Mayotte, Mexico, Moldova, Monaco, Mongolia, Monserrat, Morocco, Mozambique, Myanmar, Namibia, Nauru, Nepal, Netherlands Antilles, New Caledonia, New Zealand, Nicaragua, Niger, Nigeria, Niue, Norway, Oman, Pakistan, Palau, Panama, Papua New Guinea, Paraguay, Peru, Philippines, Pitcairn Islands, Poland, Portugal, Puerto Rico, Qatar, Republic Of Georgia, Republic Of Korea, Republic Of Singapore, Reunion, Romania, Russia, Rwanda, Saint Helena, Saint Kitts And Nevis, Saint Lucia, Saint Pierre And Miquelon, Saint Vincent And The Grenadines, Samoa, San Marino, Sao Tome and Principe, Saudi Arabia, Senegal, Seychelles, Sierra Leone, Slovakia, Slovenia, Solomon Islands, Somalia, South Africa, Spain, Sri Lanka, Sudan, Surivalue, Swaziland, Sweden, Switzerland, Syria, Tahiti, Taiwan, Tajikistan, Tanzania, Thailand, The Netherlands, Togo, Tonga, Trinidad And Tobago, Tristan Da Cunha, Tunisia, Turkey, Turkmenistan, Turks And Caicos Islands, Tuvalu, Uganda, Ukraine, United Arab Emirates, United Kingdom, United States, Uruguay, Uzbekistan, Vanuatu, Venezuela, Vietnam, Virgin Islands (US), Wallis And Futuna, Yemen, Yugoslavia, Zambia, Zimbabwe
Option.OutputCountryFormat	Specifies the format to use for the country name returned in the Country output field. For example, if you select English, the country name "Deutschland" would be returned as "Germany". E Use English country names (default). I Use two-letter ISO abbreviation for the countries instead of country names. U Use Universal Postal Union abbreviation for the countries instead of country names.
Option.OutputScript	Specifies the alphabet or script in which the output should be returned. This option is bi-directional and generally takes place from Native to Latin and Latin to Native. Input Do not perform transliteration and provide output in the same script as the input (default). Native Output in the native script for the selected country wherever possible. Latn Use English values.
Acceptance level Option.AcceptanceLevel	Specifies the minimum verification level a record must reach to be considered successfully processed. The value in this field corresponds to the second character of the Address Verification Code, which is called "Post-Processed Verification Match Level": 5—Delivery point (building or post box). The record will be passed or will have high confidence if ApartmentNumber, HouseNumber, Street, City, and StateProvince supplied in the input record match to the Loqate reference dataset. Will have moderate confidence if ApartmentNumber is correct but other remaining fields are incorrect, but in this case the Loqate engine should able to identify the ApartmentNumber as ApartmentNumber is at a more granular level. It will have zero confidence if ApartmentNumber and other fields are unable to parsed by the Loqate engine. 4—Premise or building. The record will be passed or will have high confidence if House Number, Street, City, and StateProvince supplied in the input record match the Loqate reference dataset. Will have moderate confidence if HouseNumber is correct but the other fields are not; however, in this case the Loqate engine should able to identify the HouseNumber because HouseNumber is at a more granular level. It will have zero confidence if the HouseNumber and other fields are unable to parsed by the Loqate engine. 3—Thoroughfare, road, or street. The record will be passed or will have high confidence if Street, City, and StateProvince supplied in the input record match the Loqate reference dataset. Will have moderate confidence if City is correct but StateProvince is not; however, in this case the Loqate engine should able to identify the StateProvince as City itself is the part of StateProvince. It will have zero confidence if City or both fields (City and State Province) are unable to parsed by the Loqate engine. 2—Locality (city or town). The record will be passed or will have high confidence if both City and StateProvince supplied in the input record match the Loqate reference dataset. Will have moderate confidence if City is correct but StateProvince is not; however, in this case the Loqate Engine should able to identify the StateProvince as City itself is the part of StateProvince. It will have zero confidence if City or both fields (City and StateProvince) are unable to be parsed by the Loqate engine. 1—Administrative area (state or region). The record will be passed or will have high confidence if the StateProvince supplied in the input record matches the Loqate reference dataset. 0—None. This is equivalent to loosest match option.
Option.IsDuplicateHandlingMaskEnable	Enables the duplicate handling mask and specifies how duplicate records are processed and removed. Select one or more of the following options: S Selected by default. Preprocess the input and remove duplicates that occur in a single field. C Selected by default. Pre-process the input and remove duplicates across all fields. T Pre-process the input and remove duplicates in fields that are not standard address fields. F Selected by default. Post-process the output from verification and remove duplicates from non-verified fields.
Option.MinimumMatchScore	Specifies a numeric value between 0 and 100 that indicates the degree to which Validate Address Loqate will change an address in order to obtain a match in the Loqate reference database. The lower the number, the greater amount of change is allowed. A value of 100 means that after parsing the input address is nearly identical to the validated address. A value of 0 means that the parsed input address may be completely changed in order to obtain a validated address.
Option.KeepMultimatch	Specifies whether or not to return multiple address for those input addresses that have more than one possible match. Y Yes, return multiple matches (default). N No, do not return multiple matches. For more information, see Returning Multiple Matches.
Option.FailMultipleMatches	Fails multiple addresses for those input addresses that have more than one possible match.