services / location / cloud / 1.0 / address-validation

Data Enrichment

Location can enrich an address with additional data during validation if requested via the "include" attribute:

Coordinates

Coordinates can be requested via the "include" Attribute "coordinates-wgs84". The coordinates are in decimal degrees format.
The following table describes all relevant output fields:

Field Description

lat

Latitude of the WGS-84 coordinate.
Examples: 48.89855 or -17.77016

lon

Longitude of the WGS-84 coordinate.
Examples: 8.66726 or -149.48018

precision

The accuracy level of the coordinates. The most accurate coordinate is at the house number level.
The following levels exist:

1. locality
2. street
3. house-number-range
4. house-number

Example: house-number

Country Information (ISO-3166-1)

Country information can be requested via the "include" Attribute "country-info".
The following table describes all relevant output fields:

Field Description

iso3166_1Name

Official ISO-3166-1 Name of the country.
Example: Germany

iso3166_1Alpha2

Official ISO-3166-1 two letter code (alpha-2) of the country.
Example: DE

iso3166_1Alpha3

Official ISO-3166-1 three letter code (alpha-3) of the country.
Example: DEU

iso3166_1Numeric

Official ISO-3166-1 numeric code of the country.
Example: 276

Region Information (ISO-3166-2)

Region information can be requested via the "include" Attribute "region-info".
If we cannot be sure if we have the official ISO-3166-2 information can be provided we return the "regionCode" and "regionName", otherwise the ISO-3166-2 values will be returned. The following table describes all relevant output fields:

Field Description

iso3166_2Name

Official ISO-3166-2 name of the region.
Example: Baden-Württemberg

iso3166_2Code

Official ISO-3166-2 code of the region.
Example: DE-BW

regionCode

Code of the region. Not the official ISO-3166-2.

regionName

Name of the region. Not the official ISO-3166-2.

Municipality Information

Municipality information can be requested via the "include" Attribute "municipality-info".
The following table describes all relevant output fields:

Field Description

municipalityName

Official name of the municipality.
Example: Pforzheim, Stadt

municipalityCode

Official code of the Municipality.
Example: 08231000

Delivery Information

Additional information regarding the delivery can be requested via the "include" Attribute "delivery-info".
The following table describes all relevant output fields:

Field Description

postalCodeAddition

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

Address Information

Additional information about the country can be requested via the "include" Attribute "address-info".
The following table describes all relevant output fields:

Field Description

key

Key of the attribute.
Example: freguesi-name

value

Value of the attribute.
Example: Mina de Água

These are the current available attributes

Country Field Description

PT

freguesi-name

It is the name of the composite hierarchical code (region code + municipal code + district code) and describes the smallest administrative unit in Portugal.

PT

freguesi-code

It is a composite hierarchical code (region code + municipal code + district code) and describes the smallest administrative unit in Portugal.