Uniserv DOCUMENTATION / location / 1.0 / Changelog 2021

20.12.2021

New - Highlights

Validation: Optimized status detection

Example 1: Using the new Phonetic filter

Field	Input	Result
Country	DE	DE
PostalCode	75417	75417
Locality	Mühlacker	Mühlacker
Street	Arnnostraße	Arnaudstr.

Field

Input

Result

Country

DE

PostalCode

75417

Locality

Mühlacker

Street

Arnnostraße

Arnaudstr.

Click to see the request - structured validation

{
    "country":"DE",
    "postalCode":"75417",
    "locality":"Mühlacker",
    "street":"Arnnostraße",
    "_options": {
        "include": ["metadata"],
        "addressTypes": ["delivery", "po-box", "major-customer", "parcel-pick-up-station"]
    }
}

Example 2: Using the new Phonetic filter

Field	Input	Result
Country	DE	DE
PostalCode	92369	92369
Locality	Sengenthal	Sengenthal
Street	Weixelsteiner Str.	Weichselsteiner Str.

Field

Input

Result

Country

DE

PostalCode

92369

Locality

Sengenthal

Street

Weixelsteiner Str.

Weichselsteiner Str.

Click to see the request - structured validation

{
    "country":"DE",
    "postalCode":"92369",
    "locality":"Sengenthal",
    "street":"Weixelsteiner Str.",
    "_options": {
        "include": ["metadata"],
        "addressTypes": ["delivery", "po-box", "major-customer", "parcel-pick-up-station"]
    }
}

Fixed bugs

API gateway returns 500 Internal Server Error when missing Authentication header
Correct handling of German umlauts

24.11.2021

New - Highlights

Validation: New authentication mode using a session token

In addition to using the API key for authentication, the validation endpoint can also be used with a session token, created by the start-session endpoint, as described in the API reference). In this case, the session token needs to be added as Bearer token in the Authorization header.

Fixed bugs

Any extra tokens present in house number field that are more than 2 characters long are treated as unidentified elements. Previously this was true for tokens longer than 4 characters. Tokens containing 'Umlauts' are treated equally to the rest of the tokens.

06.10.2021

New - Highlights

Validation: Improved identification of po-box addresses

We allow a greater variance in the input of PoBox information and small spelling errors in the PoBox keyword.

Example 1: poBox keyword and number entered in the street field

Field	Input	Result
Country	DE	DE
PostalCode	52022	52022
Locality	Aachen	Aachen
Street	Postfch 102201
PoBox		Postfach 102201

Field

Input

Result

Country

DE

PostalCode

52022

Locality

Aachen

Street

Postfch 102201

PoBox

Postfach 102201

Click to see the request - structured validation

{
    "country":"DE",
    "postalCode":"52022",
    "locality":"Aachen",
    "street":"Postfch 102201",
    "_options": {
        "include": ["metadata"],
        "addressTypes": ["delivery", "po-box", "major-customer", "parcel-pick-up-station"]
    }
}

Example 2: poBox keyword entered in street field and the number entered in the houseNumber field.

Field	Input	Result
Country	DE	DE
PostalCode	52022	52022
Locality	Aachen	Aachen
Street	Postfach
HouseNumber	102201
PoBox		Postfach 102201

Field

Input

Result

Country

DE

PostalCode

52022

Locality

Aachen

Street

Postfach

HouseNumber

102201

PoBox

Postfach 102201

Click to see the request - structured validation

{
    "country":"DE",
    "postalCode":"52022",
    "locality":"Aachen",
    "street":"Postfach",
    "houseNumber":"102201",
    "_options": {
        "include": ["metadata"],
        "addressTypes": ["delivery", "po-box", "major-customer", "parcel-pick-up-station"]
    }
}

Example 3: The keyword is automatically translated into the stored national language of the address. Sometimes there are also different keywords within a country (e.g. in Switzerland there are the keywords "Case Postale" or "Postfach", depending on the language of the respective region).

Field	Input	Result
Country	CH	CH
PostalCode	3401	3401
Locality	Burgdorf	Burgdorf
PoBox	Case Postale 20 10	Postfach 2010

Field

Input

Result

Country

CH

PostalCode

3401

Locality

Burgdorf

PoBox

Case Postale 20 10

Postfach 2010

Click to see the request - structured validation

{
    "country":"CH",
    "postalCode":"3401",
    "locality":"Burgdorf",
    "poBox": "Case Postale 20 10",
    "_options": {
        "include": ["metadata"],
        "addressTypes": ["delivery", "po-box", "major-customer", "parcel-pick-up-station"]
    }
}

Autocomplete: Requests can now be done with a session token

Requests to /autocomplete no longer require an API key. They can now be done with a valid session token in the Authorization header in the form of 'Authorization: Bearer YOUR-SESSION-TOKEN-HERE' (see the API reference)

Fixed bugs

Entered house number with alpha part doesn’t change the street anymore.

Field	Input	Incorrect behavior	Fix
Country	DE	DE	DE
PostalCode	48565	48565	48565
Locality	Steinfurt	Steinfurt	Steinfurt
Street	Rolinckstr. 11a	Alexander-Rolinckstr.	Rolinckstr.
HouseNumber		11	11 A

Field

Input

Incorrect behavior

Fix

Country

DE

PostalCode

48565

Locality

Steinfurt

Street

Rolinckstr. 11a

Alexander-Rolinckstr.

Rolinckstr.

HouseNumber

11

11 A

Fixed typos and broken links in the documentation

In street and address line fields we do not lose tokens and give priority to the tokens at the beginning of the line

Field	Input	Incorrect behavior	Fix
Country	DE	DE	DE
PostalCode	08606	08606	08606
Locality	Tirpersdorf	Tirpersdorf	Tirpersdorf
Street	Forstweg 4 OT Brotenfeld	Brotenfelder Str.	Forstweg
HouseNumber		4 OT Brotenfeld	4 OT Brotenfeld

Field

Input

Incorrect behavior

Fix

Country

DE

PostalCode

08606

Locality

Tirpersdorf

Street

Forstweg 4 OT Brotenfeld

Brotenfelder Str.

Forstweg

HouseNumber

4 OT Brotenfeld

31.08.2021

New - Highlights

Validation: Improved identification through scoring adjustments

A new "internal" status as well as the integration of sub-locality and municipality into the scoring concept allow for a better evaluation of the correct address candidate.

Example 1: "Frauenhofen" is not the locality. It’s the subLocality entered in the wrong field.

Field	Input	Result
Country	AT	AT
PostalCode	3430	3430
Locality	Frauenhofen	Tulln an der Donau
SubLocality		Frauenhofen
Street	Landstraße

Field

Input

Result

Country

AT

PostalCode

3430

Locality

Frauenhofen

Tulln an der Donau

SubLocality

Frauenhofen

Street

Landstraße

Click to see the request - structured validation

{
    "country":"AT",
    "postalCode": "3430",
    "locality": "Frauenhofen",
    "subLocality": "",
    "street": "Landstraße",
    "houseNumber": "",
    "_options": {
        "include": ["metadata"],
        "addressTypes": ["delivery", "po-box", "major-customer", "parcel-pick-up-station"]
    }
}

Example 2: "Südheide" is not the locality but the municipality of the address.

Field	Input	Result
Country	DE	DE
PostalCode	29345	29345
Locality	Südheide	Unterlüß
SubLocality	Unterlüß	Unterlüß
Street	Danzinger Str.	Danzinger Str.

Field

Input

Result

Country

DE

PostalCode

29345

Locality

Südheide

Unterlüß

SubLocality

Unterlüß

Street

Danzinger Str.

Click to see the request - structured validation

{
    "country":"DE",
    "postalCode": "29345",
    "locality": "Südheide",
    "subLocality": "Unterlüß",
    "street": "Danziger Str.",
    "houseNumber": "",
    "_options": {
        "include": ["metadata"],
        "addressTypes": ["delivery", "po-box", "major-customer", "parcel-pick-up-station"]
    }
}

Validation: House number recognition improved

Additional information that doesn’t belong to the house number ("c/o Mr. Müller", "Uniserv GmbH", "ring 2 x", etc.) is better recognized. The additional information isn’t lost, but returned separately (field "unidetifiedElements"), so that it can be used if necessary.

Examples: "Uniserv GmbH" does not belong to the house number and is therefore returned inside the "unidentifiedElements" field, so that the information isn’t lost.

Field	Input	Result
Country	DE	DE
PostalCode	75179	75179
Locality	Pforzheim	Pforzheim
Street	Rastatter Str.	Rastatter Str.
HouseNumber	13 Uniserv GmbH	13	unidentifiedElements = Uniserv GmbH

Field

Input

Result

Country

DE

PostalCode

75179

Locality

Pforzheim

Street

Rastatter Str.

HouseNumber

13 Uniserv GmbH

13

unidentifiedElements = Uniserv GmbH

Click to see the request - structured validation

{
    "country":"DE",
    "postalCode": "75179",
    "locality": "Pforzheim",
    "subLocality": "",
    "street": "Rastatter Str.",
    "houseNumber": "13 Uniserv GmbH",
    "_options": {
        "include": ["metadata"],
        "addressTypes": ["delivery", "po-box", "major-customer", "parcel-pick-up-station"]
    }
}

House number recognition has also improved for the field "street", in case the house number was entered there by accident. The same applies for semi-structured validation (field "addressLine").

Field	Input	Result
Country	DE	DE
PostalCode	75179	75179
Locality	Pforzheim	Pforzheim
Street or AddressLine	Rastatter Str. 13 Uniserv GmbH	Rastatter Str.
HouseNumber		13	unidentifiedElements = Uniserv GmbH

Field

Input

Result

Country

DE

PostalCode

75179

Locality

Pforzheim

Street or AddressLine

Rastatter Str. 13 Uniserv GmbH

Rastatter Str.

HouseNumber

13

unidentifiedElements = Uniserv GmbH

Click to see the request - structured validation; hno in street field entered

{
    "country":"DE",
    "postalCode": "75179",
    "locality": "Pforzheim",
    "subLocality": "",
    "street": "Rastatter Str. 13 Uniserv GmbH",
    "houseNumber": "",
    "_options": {
        "include": ["metadata"],
        "addressTypes": ["delivery", "po-box", "major-customer", "parcel-pick-up-station"]
    }
}

Click to see the request - semi-structured validation

{
    "country":"DE",
    "postalCode": "75179",
    "locality": "Pforzheim",
    "subLocality": "",
    "addressLine": "Rastatter Str. 13 Uniserv GmbH",
    "houseNumber": "",
    "_options": {
        "include": ["metadata"],
        "addressTypes": ["delivery", "po-box", "major-customer", "parcel-pick-up-station"]
    }
}