Post Request Parameters
All addresses use this format regardless of the country of the address.
| Parameter | Format | Description |
|---|---|---|
| AddressLine1-AddressLine5 | String | The first till fifth address line |
| City | String | The city name. |
| Country | String | The country code or name, in any of the following formats:
|
| FirmName | String | The company or firm name. |
| PostalCode | String | The postal code for the address in one of the following
formats: 99999 99999-9999 A9A9A9 A9A 9A9 9999 999 |
| StateProvince | String | The state or province. |
| OutputCasing | String | Specifies the casing of the output data. It can be: M: The output in mixed case (default). For example:123 Main St Mytown FL 12345 U: The output in upper case. For example:123 MAIN ST MYTOWN FL 12345 |
| OutputScript | String | 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 Script: 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. |
| OutputAddressBlocks | String | 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. The possible values are: N: No, do not return address blocks. Y: Yes, return address blocks (Default). |
| KeepMultimatch | String | Specifies whether or not to return multiple address for those
input addresses that have more than one possible match. Y: Yes, return multiple matches . N: No, do not return multiple matches (default). |
| OutputCountryFormat | String | 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. |
| MaximumResults | String | A number between 1 and 10 that indicates the maximum number of addresses to return. The default is 10. |
| OutputFieldLevelReturnCodes | String |
Specifies whether to include field-level result indicators. These indicators describe how each address element was handled, and are returned in the qualifier "Result". For example, the field-level result indicator for HouseNumber is contained in HouseNumber.Result. N No, do not output field-level return codes (default). Y Yes, output field-level return codes. |
| OutputRecordType | String |
Specifies the type of output record you get. For more than one, provide a list. A Returns 1 to 4 lines of address data, city, state, postal code, firm name, and urbanization name. Each address line represents an actual line of the address as it would appear on an envelope. If the address is validated, the address lines contain the standardized address. When addresses are standardized, punctuation is removed, directional are abbreviated, street suffixes are abbreviated, and address elements are corrected. If the address is not validated, the address lines contain the address as it appeared in the input ("pass through" data). Non-validated addresses are always included as pass through data in the address line fields even if you do not specify OutputRecordType=A. E Parsed address elements Each part of the address, such as house number, street name, street suffix, and directional is returned in a separate field. I Parsed input This option returns the input address in parsed form regardless of whether the address is validated. Each part of the input address, such as house number, street name, street suffix, and directional is returned in a separate field. |
user_fields section of the response. For POST requests, user
fields are passed in as part of the user_fields element in the XML
or JSON request.