{
"country":"DE",
"postalCode":"67",
"locality":"Neustadt",
"street":"Hauptstr.",
"_options": {
"include": ["metadata"],
"addressTypes": ["delivery", "po-box", "major-customer", "parcel-pick-up-station"]
}
}
Changelog 2022
13.12.2022
-
minor technical changes (no action required)
-
release contains also new index data
Fixed bugs
-
corrected validation problems for country Croatia
29.09.2022
-
Technical modification (no action required): usage of the new (internal) search engine client
07.09.2022
New - Highlights
-
enabled world-wide address validation
Further changes
-
Technical modification (no action required): performed major version upgrade for the internal search engine
26.07.2022
-
new fields like dependentStreet, subBuilding, organization
Fixed bugs
-
correct handling of session token in hybrid mode
06.07.2022
Fixed bugs
-
correct handling of spaces in postalcodes
24.05.2022
New - Highlights
New Request and Response Parameter for the post-office box (P.O. Box)
In countries like Switzerland and Austria, entering a P.O. Box number is sometimes optional. In Germany, however, the entry is required. To better differentiate here, we separate the entered information into Keyword and Number.
Example: PoBox-Input without Keyword
Field | Input | Result |
---|---|---|
Country |
DE |
DE |
PostalCode |
76232 |
76232 |
Locality |
Karlsruhe |
Karlsruhe |
PoBoxKeyword |
(only in Response) |
Postfach |
PoBoxNumber |
100206 |
100206 |
Example: PoBox-Input with Keyword
Field | Input | Result |
---|---|---|
Country |
DE |
DE |
PostalCode |
76232 |
76232 |
Locality |
Karlsruhe |
Karlsruhe |
PoBoxKeyword |
(only in Response) |
Postfach |
PoBoxNumber |
Postfach 100206 |
100206 |
Single Line Autocompletion: Improved autocompletion by allowing spelling mistakes in the user input
Fuzzy search can be used only in SingleLine Autocompletion to get a list of results based on likely relevance even though search
words may be not exactly match.
The fuzzy feature must be activated by the include option fuzzy-search
in the request.
Input | Result |
---|---|
pforzheim rastater str 13 |
75179 Pforzheim Rastatter Str. 13 |
pforzheim rassater str 13 |
75179 Pforzheim Rastatter Str. 13 |
Single Line Autocompletion: Considering also 'related' postalcodes
The Single-Line Autocompletion also takes into account other postal codes of the same municipality.
The fuzzy feature must be activated by the include option fuzzy-search
in the request.
Input | Result |
---|---|
76602 Kai |
76646 Bruchsal Kaiserstr. |
4001 Käf |
4058 Basel Käferholzstrasse |
The field addressLine supports autocompletion
The field addressLine
is used to enter the street name and house number or the poBox in one field instead of using
different fields.
Input | Result |
---|---|
Haupt 15 |
Hauptstr. 15 |
117er ehren 11e |
117er Ehrenhof 11e |
05.05.2022
Fixed bugs
-
This release fixes the security vulnerability CVE-2022-21449
12.04.2022
New - Highlights
Single Line Autocompletion: Improved handling of numbers present in street names and distinguishing them from house numbers
Some street names contain numbers that can be written together or separately from the name. Now we are allowing more flexibility in the way how the names can be written. Also, house numbers are now better recognized. For example:
Input | Result |
---|---|
117er ehren 12 |
Berlin, 117er Ehrenhof 12 |
117 er ehren 12 |
Berlin, 117er Ehrenhof 12 |
Mannheim n5 12 |
Mannheim, N 5 12 |
Mannheim N 5 12 |
Mannheim, N 5 12 |
berlin 17.juni 12 |
Berlin, Straße des 17. Juni 12 |
berlin 17juni 12 |
Berlin, Straße des 17. Juni 12 |
Single Line Autocompletion: Considering the order of po box numbers by po box addresses
The position and length of the Po Box number within the user input is very important and decides whether the entered number is interpreted as PoBox number or as postalCode. If the number entered after the word Postfach (or its synonym) and its length is not equal to the length of postalCode, the number would be interpreted as PoBox number, otherwise it would be interpreted as postalCode. The number would be interpreted as postalCode, if it is entered after the word Postfach (or its synonym) followed by whitespace and its length is equal to the length of postalCode.
Input | Result |
---|---|
10205 Postfach |
10205 Berlin Postfach |
10205 Postfach 1020 |
10205 Berlin Postfach 1020 |
Postfach 1020 |
01001 Dresden Postfach 1020 |
Geo coordinates for the address
The Api parameters coordinates-wgs84-point
and coordinates-wgs84-calculated
to get Geo coordinates for an address have been replaced by the parameter coordinates-wgs84
and Api-Clients must use the last one.
Optimized detection of locality
Detection of locality has been optimized to find the best address even by incomplete or incorrect user input.
Example: Incomplete input of locality
Field | Input | Result |
---|---|---|
Country |
AT |
AT |
PostalCode |
8770 |
8770 |
Locality |
St. Micheal |
St. Michael in Obersteiermark |
Street |
Kirchgasse |
Kirchgasse |
HouseNumber |
1 |
1 |
Example: Incorrect input of locality
Field | Input | Result |
---|---|---|
Country |
AT |
AT |
PostalCode |
8770 |
8770 |
Locality |
St. Michel |
St. Michael in Obersteiermark |
Street |
Kirchgasse |
Kirchgasse |
HouseNumber |
1 |
1 |
15.03.2022
New - Highlights
Validation: Improved handling of enclaves
A special thing about enclaves is that they can be addressed with two different country codes and two different postal codes. This has lead to inconsistent information of country code, country info and postal code.
With the improved handling, country code and postal codes are always returned in a consistent way. Furthermore, the include option "country-info" (which returns ISO3166-1 codes) will always be aligned to the territorial country where the enclave belongs to.
Example: Uniform input of country and postal code (both DE)
Field | Input | Result |
---|---|---|
Country |
DE |
DE |
PostalCode |
87567 |
87567 |
Locality |
Riezlern |
Riezlern |
Street |
Söllerweg |
Söllerweg |
CountryInfo |
||
Iso3166_1Name |
Austria |
|
Iso3166_1Alpha2 |
AT |
|
Iso3166_1Alpha3 |
AUT |
|
Iso3166_1Numeric |
040 |
Example: Uniform input of country and postal code (both AT)
Field | Input | Result |
---|---|---|
Country |
AT |
AT |
PostalCode |
6991 |
6991 |
Locality |
Riezlern |
Riezlern |
Street |
Söllerweg |
Söllerweg |
CountryInfo |
||
Iso3166_1Name |
Austria |
|
Iso3166_1Alpha2 |
AT |
|
Iso3166_1Alpha3 |
AUT |
|
Iso3166_1Numeric |
040 |
Example: Mixed input of country (DE) and postal code (AT)
Field | Input | Result |
---|---|---|
Country |
DE |
DE |
PostalCode |
6991 |
87567 |
Locality |
Riezlern |
Riezlern |
Street |
Söllerweg |
Söllerweg |
CountryInfo |
||
Iso3166_1Name |
Austria |
|
Iso3166_1Alpha2 |
AT |
|
Iso3166_1Alpha3 |
AUT |
|
Iso3166_1Numeric |
040 |
Example: Mixed input of country (AT) and postal code (DE)
Field | Input | Result |
---|---|---|
Country |
AT |
AT |
PostalCode |
87567 |
6991 |
Locality |
Riezlern |
Riezlern |
Street |
Söllerweg |
Söllerweg |
CountryInfo |
||
Iso3166_1Name |
Austria |
|
Iso3166_1Alpha2 |
AT |
|
Iso3166_1Alpha3 |
AUT |
|
Iso3166_1Numeric |
040 |
Validation: Improved handling of municipality and sub-locality input
It is not always clear to users if the commonly used name of a locality is really the official name of that locality, or if it is actually the name of the municipality or sub-locality. Therefore it happens that users enter a sub-locality name or a municipality name into the locality-field. If the user-input has no further mistakes, it will be corrected and still lead to a good validation-result.
Example: Input of a sub-locality in the locality field
Field | Input | Result | Status |
---|---|---|---|
Country |
AT |
AT |
IDENTIFIED |
PostalCode |
9064 |
9064 |
IDENTIFIED |
Locality |
Lassendorf |
Magdalensberg |
CHANGED |
SubLocality |
Lassendorf |
IDENTIFIED |
|
Street |
Steingasse |
Steingasse |
IDENTIFIED |
ResultClass |
C |
Example: Input of a municipality in the locality field
Field | Input | Result | Status |
---|---|---|---|
Country |
CH |
CH |
IDENTIFIED |
PostalCode |
5085 |
5085 |
IDENTIFIED |
Locality |
Laufenburg |
Sulz AG |
CHANGED |
Municipality |
Laufenburg |
IDENTIFIED |
|
Street |
Kleinstadt |
Kleinstadt |
IDENTIFIED |
ResultClass |
C |
Fixed bugs
-
po-box addresses will only be returned when po-box option is set
17.02.2022
New - Highlights
Validation: Normalized status in case of special characters difference
Return Normalized status for cases when user input differs only in spaces or other special characters
Example: Street names with separators-only difference
Field | Input | Result | Status |
---|---|---|---|
Street |
Kappelwindeck str |
Kappelwindeckstr. |
NORMALIZED |
Street |
Annette-von-Droste-Hülshoff-Weg |
Annette von Droste Hülshoff Weg |
NORMALIZED |
Street |
AnnettevonDrosteHülshoffWeg |
Annette von Droste Hülshoff Weg |
NORMALIZED |
Fixed bugs
-
Parcel pick-up stations and Post Office numbers are present in the response as house number
-
Recognition of LI (Liechtenstein) country code and its redirection to CH core
18.01.2022
New - Highlights
Validation: Optimized handling of incomplete postal codes
Postal codes in the input which are not complete will return reasonable results.
Example: Incomplete postal code
Field | Input | Result |
---|---|---|
Country |
DE |
DE |
PostalCode |
67 |
67433 |
Locality |
Neustadt |
Neustadt an der Weinstraße |
Street |
Hauptstr. |
Hauptstr. |
Click to see the request - structured validation
Validation: Improved house-number recognition in address line
Even complex house number/street combinations in the address line will be addigned correctly
Example: Street name has number as well
Field | Input | Result |
---|---|---|
Country |
DE |
DE |
PostalCode |
55118 |
55118 |
Locality |
Mainz |
Mainz |
Addressline |
117 Ehrenhof 13 |
|
Street |
117er Ehrenhof |
|
HouseNumber |
13 |
Click to see the request - structured validation
{
"country":"DE",
"postalCode":"55118",
"locality":"Mainz",
"addressLine": "117 Ehrenhof 13",
"houseNumber": "",
"_options": {
"include": ["metadata"],
"addressTypes": ["delivery", "po-box", "major-customer", "parcel-pick-up-station"]
}
}
Example: Street name has number, no house number given
Field | Input | Result |
---|---|---|
Country |
DE |
DE |
PostalCode |
36277 |
36277 |
Locality |
Schenklengsfeld |
Schenklengsfeld |
Addressline |
Wippershain 13. Str. |
|
Street |
Wippershain 13. Str. |
|
HouseNumber |
Click to see the request - structured validation
{
"country":"DE",
"postalCode":"36277",
"locality":"Schenklengsfeld",
"addressLine": "Wippershain 13. Str.",
"houseNumber": "",
"_options": {
"include": ["metadata"],
"addressTypes": ["delivery", "po-box", "major-customer", "parcel-pick-up-station"]
}
}
Example: Street with several numbers, and misplaced house number
Field | Input | Result |
---|---|---|
Country |
DE |
DE |
PostalCode |
63067 |
63067 |
Locality |
Offenbach |
Offenbach am Main |
Addressline |
12 Pl 8 M 1945 |
|
Street |
Platz des 8.Mai 1945 |
|
HouseNumber |
12 |
Click to see the request - structured validation
{
"country":"DE",
"postalCode":"63067",
"locality":"Offenbach",
"addressLine": "12 Pl 8 M 1945",
"houseNumber": "",
"_options": {
"include": ["metadata"],
"addressTypes": ["delivery", "po-box", "major-customer", "parcel-pick-up-station"]
}
}
Fixed bugs
-
Problem identifying inputs with uppercase mutated vowels (umlauts)