services / location / cloud / 1.0 / address-structuring

Data Model

The Structure API splits a single-line address into its individual components using an AI model. The result may vary over time and by country.

Request Fields

The following table describes the input fields.

Field Type Description

address

string

An unstructured address in one line. Order of elements can be free, but logical sequencing improves accuracy.
Example: Uniserv GmbH Roland Pfeiffer Geschäftsführung Rastatter Str. 13 75179 Pforzheim

Response Fields

The following table describes the output fields.

Field Type Description

country

string

Detected country code if possible. The country code is important/mandatory for the recommended following address validation.

postalCode

string

Postal code element, if recognized.

locality

string

City or town name element, if recognized.

subLocality

string

Sub‑locality (district/neighborhood) element, if recognized.

street

string

Street name element, if recognized.

houseNumber

string

House number element, if recognized.

recipient

string

Person or name element, if identified.

organization

string

Organization element, if identified.

organizationAddition

string

Additional organization info (e.g., department), if present.

unidentifiedElements

array of string

Words or tokens that couldn’t be assigned to any field.
Output Example
{
  "country": "DE",
  "postalCode": "75179",
  "locality": "Pforzheim",
  "subLocality": null,
  "street": "Rastatter Str.",
  "houseNumber": "13",
  "recipient": "Roland Pfeiffer",
  "organization": "Uniserv GmbH",
  "organizationAddition": "Geschäftsführung",
  "unidentifiedElements": []
}