Country-specific informations. For now only available in Portugal.

value

Address information

Meta data that explains why this candidate matches the requested input address. Only set if requested options include metadata.

Metadata for various fields

Meta data

The relevance of this field to the match of this candidate.

<table>
<tr><th>Relevance</th><th>Description</th></tr>
<tr><td>MANDATORY</td><td>All mandatory fields must NOT have the status NOT_IDENTIFIED.</td></tr>
<tr><td>IMPORTANT</td><td>Important fields may only have the status NOT_IDENTIFIED if all other fields match well.</td></tr>
<tr><td>OPTIONAL</td><td>Optional fields may have the status NOT_IDENTIFIED.</td></tr>
<tr><td>NOT_RELEVANT</td><td>Not relevant fields are not checked for a match.</td></tr>
</table>

The status of this field to the match of this candidate.

<table>
<tr><th>Status</th><th>Description</th></tr>
<tr><td>IDENTIFIED</td><td>Perfect match. Example for field locality: Input: Berlin Candidate: Berlin</td></tr>
<tr><td>NORMALIZED</td><td>Matched after normalization. Example for field locality: Input: Köln Candidate: Koeln</td></tr>
<tr><td>CHANGED</td><td>Matched after input was corrected. Example for field locality: Input: Brlin Candidate: Berlin</td></tr>
<tr><td>ADDED</td><td>No data in input field. Field was populated by us.</td></tr>
<tr><td>EMPTY</td><td>No data in input field and no data on our side. Field remains empty.</td></tr>
<tr><td>NOT_CHECKED</td><td>The field was not checked because it is not relevant or the check is not licensed. Example: The field region in CH is not relevant for delivery → not checked.</td></tr>
<tr><td>NOT_IDENTIFIED</td><td>The input value of this field was not identified (not even with errors) and the value was not corrected. Example: The given street does not match to the postalCode and locality.</td></tr>
</table>

Any unidentified elements in the input address.

If this is set the fields street, houseNumber, building and poBoxNumber must not be set.

Combination of street and house number (and building) in one line

Country of the address. Must be set to a supported country in ISO 3166-1 alpha-2 format e.g. "DE".

Country code

Custom id set by the user to identify matching request and result from Batch run

If this is set the fields postalCode, locality & subLocality must not be set.

Combination of postal code, locality & sub locality in one line

Additional information of the organization e.g. which department.

Only 'delivery' addresses are returned by default. You can also request other types of addresses additionally. Note that 'delivery' addresses cannot be deselected and will always be requested.

The ``coordinates-wgs84`` include option is available with an active Premium license only. The ``fuzzy-search`` include option is reserved for autocomplete requests and is not available for address validation requests.

Possible additional fields to include in the response.

Desired Language of the address in ISO 639-1 format e.g. "de".

Enables the search for historical data (e.g. since "2023-01-01", "200d", "9m" or "3y").

<table><tr><th>Result Class</th><th>Description</th></tr><tr><td>A</td><td>Perfect match: The address entered is correct and complete. This means, that all mandatory address elements match exactly. There are only two exception when a mandatory address element must not match exactly:<ul><li>The necessary data is not available</li><li>The data does not have the necessary quality to validate the input.</li></ul></td></tr><tr><td>B</td><td>Normalized match: Almost a perfect match but the address has changed slightly, e.g. lower/upper case corrected or the address has been translated.</td></tr><tr><td>C</td><td>Corrected match (high certainty of match): The entered address was not entered completely or with small spelling errors, but it's still a very good result.</td></tr><tr><td>D</td><td>Probable match (no other candidates): The entered address was not entered completely or with multiple spelling errors.</td></tr><tr><td>E</td><td>Ambiguous match: The address entered is ambiguous.</td></tr><tr><td>F</td><td>No match: The address could not be identified or is incomplete.</td></tr></table>

The quality of the matched results

Best matching address candidates for the given input.

List of matching address candidates

Enter the street and house number of the address in a address line. If this field is set, Cannot be combined with street

Locality / city of the address. Cannot be combined with singleLine.

Postal code of the address. Cannot be combined with singleLine.

Enter the whole address in a single line. If this field is set, all other non-required fields must not be set.

Street of the address. Cannot be combined with singleLine.

Sub locality / district of the address. Cannot be combined with singleLine.

Only ``delivery`` addresses are returned by default. You can also request other types of addresses additionally. Note that ``delivery`` addresses cannot be deselected and will always be requested.

Only the include option ``fuzzy-search`` is available for autocomplete requests. ``fuzzy-search`` is evaluated for single line inputs only. All other include options are reserved for address validation requests and are not available for autocomplete requests.

The possible options

Autocomplete suggestions for structured input fields.

Address Type of the result. Note that new address types may be added. Therefore clients must allow unexpected new values

Ranges of house numbers of the address. Only set if result class is E.

Sub locality abbreviation of the address.

Distance from the address house to search point

coordinates

Country codes in various representations (ISO-3166-1).

Official ISO-3166-1 two letter code (alpha-2) of the country e.g. "DE".

Official ISO-3166-1 three letter code (alpha-3) of the country e.g. "DEU".

Official ISO-3166-1 Name of the country e.g. "Germany".

Official ISO-3166-1 numeric code of the country e.g. "276".

Country information

Country of the address. Must be set to a supported country in ISO 3166-1 alpha-2 format e.g. "DE" or in ISO 3166-1 alpha-3 format e.g. "DEU".

Country-specific carrier data for delivery.

Addition of the postal code. Exists only in Switzerland and consists of two digits.

Delivery information

The range of addresses start at this house number

Flag indicating if the house numbers contained in this range are even, odd or mixed.

The range of addresses end at this house number

Information about the municipality of the address

Municipality information

Line oriented presentation designed for printing on an envelope.

First line of the address. E.g. street and houseNumber

Third line of the address. E.g. building.

Fourth line of the address. E.g. houseNumber.

Fifth line of the address. E.g. poBox.

Locality / city line of the address. E.g. postalCode and locality.

Address for printing on an envelope

Country-specific region codes (ISO-3166-2).

Official ISO-3166-2 code of the region e.g. "DE-BW".

Official ISO-3166-2 name of the region e.g. "Baden-Württemberg".

Code of the region, not the official ISO-3166-2.

Name of the region, not the official ISO-3166-2.

Region information

Defines how far in meters can houses be from the best matching house to be included in the result

Search results tolerance

Latitude

Longitude

The accuracy level of the coordinates.

<table><tr><th>Level</th><th>Accurate to:</th></tr><tr><td>house-number</td><td>House number, block of houses or a big building with several house numbers</td></tr><tr><td>house-number-range</td><td>Street section or house number range</td></tr><tr><td>street</td><td>Street</td></tr><tr><td>locality</td><td>Locality / city</td></tr></table>

WGS-84 coordinates

Uniserv GmbH

API License

Location Service REST API

Autocomplete an address either in the singleLine input field or in the other structured address fields.

Bearer token which must be a valid sessionToken returned by /start-session

Authorization

Origin

Find and validate the best result for a given input address.

In order to use the autocomplete endpoint, a valid autocomplete session is required. This endpoint is used to create that session and it returns a sessionToken for usage in autocomplete requests.

Bearer token which must be your valid API key.

Start an autocomplete session with proper authorization.

Bearer token which must be either your valid API key or a valid sessionToken returned by /start-session