International AddressThis service provides methods to search and verify international addresses. Summary | This service provides methods to search and verify international addresses. | | This service has two methods that work slightly differently. | | This method is suited to handle data entry where only partial address information is provided. | | This method expects an address that is already more or less complete. | | | | | | Search for up to twenty addresses related to the address information given. | | | | The result of an international address search. | | A international address result entry, with information on the status of each element. | | A single international address result entry. | | A single international address result entry. | | | | The possible value for the language parameter within this service. | | The format in which the country is returned. | | Address Status is an 8 character string that defines a status value per address element. |
Service methodsThis service has two methods that work slightly differently. The internationalAddressSearchV2 method expects a partial address and provides a list of suggestions from which the user can select the desired address. The internationalAddressSearchInteractive method expects a more complete address and checks and completes it. It may also return a list of suggestions. internationalAddressSearchV2This method is suited to handle data entry where only partial address information is provided. Based on the partial information a list of up to 20 addresses is suggested, saving significant key strokes when entering address data. Returns address suggestions related to the address information given. Suggestions are ranked based on a matching percentage. Per field status indications are also returned for every suggestion. Any parameter may be left empty, apart from the country parameter. Parameters| organization | Name of the company or organisation at the address | | building | Building or subbuilding name | | street | Street search phrase | | housenr | House number search phrase | | pobox | PO box search phrase | | locality | District or municipality search phrase | | postcode | Postalcode search phrase | | province | Province search phrase | | country | Country of the address, required. Accepts ISO3 country codes. | | language | Language in which the results are returned, see Preferred Language. | | country_format | The format in which the country is returned, see Country Format. |
ReturnsinternationalAddressSearchInteractiveThis method expects an address that is already more or less complete. It checks the correctness of the specified address, completing it if possible. If suggestions can be generated they will be returned as well. Returns address suggestions related to the address information given. Suggestions are ranked based on a matching percentage. Per field status indications are also returned for every suggestion. Any parameter may be left empty, apart from the country parameter. Parameters| organization | Name of the company or organisation at the address | | building | Building or subbuilding name | | street | Street search phrase | | housenr | House number search phrase | | pobox | PO box search phrase | | locality | District or municipality search phrase | | postcode | Postalcode search phrase | | province | Province search phrase | | country | Country of the address, required. Accepts ISO3 country codes. | | language | Language in which the results are returned, see Preferred Language. | | country_format | The format in which the country is returned, see Country Format. |
ReturnsinternationalAddressSearchNoticeThis method is deprecated, use internationalAddressSearchV2 instead Search for up to twenty addresses related to the address information given. The results include a matching percentage. Any parameter may be left empty, apart from the country parameter. Parameters| street | Street search phrase | | housenr | House number search phrase | | pobox | PO box search phrase | | locality | District or municipality search phrase | | postcode | Postalcode search phrase | | province | Province search phrase | | country | Country of the address, required. Accepts ISO3 abbreviations. | | page | Page to retrieve, pages start counting at 1 |
ReturnsinternationalAddressLanguageSearchSearch for up to twenty addresses related to the address information given. The results include a matching percentage. Any parameter may be left empty, apart from the country parameter. Parameters| street | Street search phrase | | housenr | House number search phrase | | pobox | PO box search phrase | | locality | District or municipality search phrase | | postcode | Postalcode search phrase | | province | Province search phrase | | country | Country of the address, required. Accepts ISO3 abbreviations. | | language | Language in which the results are returned, see below. | | page | Page to retrieve, pages start counting at 1 |
DomainsThe language parameter can have the following values. | latin | (default) Latin script version of the country’s primary language. Romanizes non latin languages. | | primary | The country’s primary language. Kanji for Japan. | | secondary | The country’s secondary language if available. Kana for Japan. | | english | Same as latin, but returns English spelling if available (ie Munich instead of München). |
ReturnsinternationalAddressSearchFormattedNoticeThis method is deprecated, use internationalAddressSearchV2 instead Search for up to twenty addresses related to the address information given. The results include a matching percentage. Any parameter may be left empty, apart from the country parameter. Similar to internationalAddressLanguageSearch, but output elements contain some extra fields, amongst others the complete formatted address. Depending on the country these fields may not be available. Parameters| street | Street search phrase | | housenr | House number search phrase | | pobox | PO box search phrase | | locality | District or municipality search phrase | | postcode | Postalcode search phrase | | province | Province search phrase | | country | Country of the address, required. Accepts ISO3 abbreviations. | | language | Language in which the results are returned, see below. | | page | Page to retrieve, pages start counting at 1 |
DomainsThe language parameter can have the following values. | latin | (default) Latin script version of the country’s primary language. Romanizes non latin languages. | | primary | The country’s primary language. Kanji for Japan. | | secondary | The country’s secondary language if available. Kana for Japan. | | english | Same as latin, but returns English spelling if available (ie Munich instead of München). |
ReturnsInternationalAddressSearchV2ResultThe result of an international address search. InternationalV2A international address result entry, with information on the status of each element. | address | An InternationalFormattedAddress element containing address data | | element_match_status | A Address Status describing how each individual address element matched the available reference data. If two elements match this does not guarantee that they are valid in combination. The possible values for each position are as follows.| 0 | empty | | 1 | not found | | 2 | not checked (no reference data or no chance of success) | | 3 | matched with errors | | 4 | matched without errors |
| | element_result_status | A Address Status describing how each address element has been modified. Each character position corresponds to an address element, in the same way as for the ‘element_match_status’ field described above. The possible values for each position are as follows.| 0 | empty | | 1 | not checked | | 2 | not checked but standardized | | 3 | checked and corrected (changed or inserted) | | 4 | validated, but changed (synonyms, old names) | | 5 | validated, but standardized | | 6 | validated and unchanged | | 7 | no value returned, due to multiple possible matches |
|
InternationalA single international address result entry. | matchrate | A matchrate between 0 and 1, denoting how well the result matches the search parameters, one being exact and 0 being no match at all. | | street | Street name of the address | | housenr | House number of the address, if available. | | pobox | PO box of the address, if available. | | locality | Locality and/or city name of the address. If both present, values will be separated with a linefeed character. | | postcode | Postalcode of the address, if available. | | province | Province or state. | | country | Country of the address. |
InternationalFormattedAddressA single international address result entry. Similar to International, but contains some extra fields. Depending on the country these fields may not be available | matchrate | A matchrate in percentages, denoting how well the result matches the search parameters. | | street | Street name of the address | | housenr | House number of the address, if available. | | pobox | PO box of the address, if available. | | locality | Locality and/or city name of the address. If both present, values will be separated with a linefeed character. | | postcode | Postalcode of the address, if available. | | province | Province or state. | | country | Country of the address. | | countryspecific_locality | Country specific alternative notation for locality | | delivery_address | Local delivery address | | formatted_address | Complete formatted address | | organization | Name of a company or organization, if available. | | department | Name or description of the department, if available. | | contact | Name or contact information of person, if available. | | building | Name of building and / or subbuilding, if available. |
Preferred LanguageThe possible value for the language parameter within this service. | latin | Latin script version of the country’s primary language. Romanizes non latin languages. | | database | (default) Returns the output in the language that is used in the address database for a given country. | | primary | The country’s primary language. Kanji for Japan. | | secondary | The country’s secondary language if available. Kana for Japan. | | english | Same as latin, but returns English spelling if available (ie Munich instead of München). | | alternative_1 | First alternative language (this is the case in countries where more than one language is spoken like Belgium, Switzerland or Canada) | | alternative_2 | Second alternative language (this is the case in countries where more than one language is spoken like Belgium, Switzerland or Canada) | | alternative_3 | Third alternative language (this is the case in countries where more than one language is spoken like Belgium, Switzerland or Canada) |
Country FormatThe format in which the country is returned. | iso_2 | ISO2 country code | | iso_3 | ISO3 country code | | iso_number | Numeric ISO country code | | abbreviation | Abbreviation of the country name as seen on license plates | | en | Name in English (default) | | cn | Name in Chinese | | da | Name in Danish | | de | Name in German | | en | Name in English | | es | Name in Spanish | | fi | Name in Finnish | | fr | Name in French | | gr | Name in Greek | | hu | Name in Hungarian | | it | Name in Italian | | jp | Name in Japanese | | kr | Name in Korean | | nl | Name in Dutch | | pl | Name in Polish | | pt | Name in Portuguese | | ru | Name in Russian | | sa | Name in Arabic | | se | Name in Swedish |
Address StatusAddress Status is an 8 character string that defines a status value per address element. Each character position corresponds to an address element. | 1 | Postal code | | 2 | Locality | | 3 | Province | | 4 | Street | | 5 | Building number | | 6 | PO Box | | 7 | Building | | 8 | Organization |
|