Validation Services
Address
The Address endpoint validates and normalizes an address, returning the street, house number, postal data, Egon codes, and geographic coordinates.
Headers & authentication
Required request headers and their expected values.
| Field | Type | Description |
|---|---|---|
tokenreq | String | Authentication token sent in the |
Request
Country context, processing options, and address fields to validate.
| Field | Type | Description |
|---|---|---|
parreq | Object | Processing options and country context for address validation. |
iso2 | String | Country code, ISO 3166-1 alpha-2. One of |
iso3 | String | Country code, ISO 3166-1 alpha-3. One of |
geo | String | Activate geocoding.
Default value: |
fmtout | String | Output format.
Default value: |
fmtsht | String | Activate short descriptions.
Default value: |
lngout | String | Output language.
|
tpxout | String | Output description format.
|
hn_code | String | Activate Egon house-number codes. Default value: |
datareq | Object | Address information to validate |
addressreq | Object | Address information to validate. All individual address fields are optional. |
egoncode_place | Number | Egon place code. |
egoncode_hn | Number | Egon house-number code. |
country | String | Country description. |
state | String | State description. |
region | String | Region description. |
province | String | Province description. |
city | String | City or municipality description. |
district1 | String | First district or locality description. |
district2 | String | Second district or locality description. |
district3 | String | Third district or locality description. |
zipcode | String | Postal code. |
street_type | String | Street type, for example Via, Viale, Piazza, or Corso. |
street | String | Street description or street name. |
address | String | Full unstructured address. |
hn | String | House number. |
care_of | String | Care-of information. |
building | String | Building information. |
sub_building | String | Sub-building information. |
organization | String | Organization name. |
street_type_str2 | String | Second street type. |
street_2 | String | Second street description. |
hn_2 | String | Second house number. |
Response
Normalized address, geocoding coordinates, postal format, quality indicators, and system status.
| Field | Type | Description |
|---|---|---|
data | Object | Normalized address data and optional output. |
name | Object | |
type_ana | String | Name analysis type |
gender | String | Gender |
full_name | String | Full name |
last_name | String | Separate surname |
mid_name | String | Middle name |
first_name | String | First name |
prename | String | Separate name |
title | String | Title |
firm_type | String | Company legal form |
birth_date | String | Date of birth |
birth_country | String | Country of birth |
birth_province | String | Province of birth |
birth_place | String | Place of birth |
name_des | String | Name description |
status | String | Validation status |
tax_code | Object | |
cod_description | String | Code description |
vat_number | Object | |
cod_description | String | Code description |
address | Object | Normalized address result. |
standard | Object | Complete structured and normalized address. |
iso2 | String | Country ISO 3166-1 alpha-2 code. |
iso3 | String | Country ISO 3166-1 alpha-3 code. |
country | String | Normalized country description. |
country_lng | String | Country language code. |
state | String | Normalized state description. |
state_code | String | State code. |
state_lng | String | State language code. |
region | String | Normalized region description. |
region_code | String | Region code. |
region_lng | String | Region language code. |
province | String | Normalized province description. |
province_code | String | Province code. |
province_lng | String | Province language code. |
city | String | Normalized city description. |
city_lng | String | City language code. |
locality | String | Normalized locality or district description. |
locality_lng | String | Locality language code. |
locality2 | String | Second locality or district description. |
locality2_lng | String | Second locality language code. |
locality3 | String | Third locality or district description. |
locality3_lng | String | Third locality language code. |
zipcode | String | Normalized postal code. |
street_type | String | Normalized street-type description. |
street_name | String | Normalized street name. |
street | String | Normalized street type and name. |
street_lng | String | Street language code. |
address | String | Formatted street address and house number. |
full_address | String | Complete normalized address. |
street_type2 | String | Second street-type description. |
street_name2 | String | Second street name. |
street2 | String | Second normalized street. |
street2_lng | String | Second street language code. |
hn | String | Normalized house number. |
hn_ext | String | Additional house-number information. |
care_of | String | Care-of information. |
hn_2 | String | Second house number. |
building | String | Building information. |
subbuilding | String | Sub-building information. |
organization | String | Organization |
postal_town1 | String | Primary postal town or area. |
postal_town2 | String | Secondary postal town or locality. |
match_code | String | Address matching result code. |
adm_code | Array | Administrative code collection. |
iso3 | String | Country ISO alpha-3 code. |
type | String | Administrative-code type. |
value | String | Administrative code or description. |
cnd | Array | Candidate address values when matching is not exact. |
province | String | Candidate province. |
city | String | Candidate city. |
locality | String | Candidate locality. |
street | String | Candidate street. |
zipcode | String | Candidate postal code. |
street_code | Number | Candidate street code. |
egon_code | Object | Egon hierarchical code collection. |
city | Number | Egon city code. |
locality | Number | Egon locality code. |
street | Number | Egon street code. |
hn | Number | Egon house-number code. |
short | Object | Short descriptions, returned when par.fmtsht is enabled. |
country | String | Country description. |
state | String | State description. |
region | String | Region description. |
province | String | Province description. |
city | String | City description. |
locality | String | Locality or district description. |
locality2 | String | Second locality description. |
locality3 | String | Third locality description. |
street_type | String | Street-type description. |
street_name | String | Street name. |
street | String | Street type and name. |
smart | Object | Simplified address representation. |
country | String | Country description |
administrative_level | String | Administrative level. |
city | String | City. |
address | String | Street type + Street description + House number |
zipcode | String | Postal code. |
geo | Object | Geocoding output, returned when par.geo is set to S. |
lat_long | String | Coordinates in latitude, longitude format. |
geo_level | String | Geocoding quality level. |
census_code | String | Census code. |
census_lat_long | String | Census coordinates. |
postal | Object | Postal-format output rows. |
row1 | String | Postal row 1. |
row2 | String | Postal row 2. |
row3 | String | Postal row 3. |
row4 | String | Postal row 4. |
row5 | String | Postal row 5. |
row6 | String | Postal row 6. |
row7 | String | Postal row 7. |
phones | Array | Phone numbers to validate |
iso3 | String | Country code (ISO 3166-1 alpha-3) |
type | String | Administrative-code type |
pre_int | String | International telephone prefix |
pre_nat | String | National telephone prefix |
number | String | Telephone number |
emails | Array | Email addresses to validate |
email | String | Email address |
codes | Array | Administrative and cadastral domain codes |
type | String | Administrative-code type |
cod_description | String | Code description |
quality | Object | Address validation quality indicators. |
phones | Array | Phone numbers to validate |
flag | String | Quality flag |
code | Number | Quality code |
description | String | Human-readable quality description |
emails | Array | Email addresses to validate |
flag | String | Quality flag |
code | Number | Quality code |
description | String | Human-readable quality description |
tax_code | Object | |
flag | String | Quality flag |
code | Number | Quality code |
description | String | Human-readable quality description |
name | Object | |
person | Object | |
flag | String | Quality flag |
code | Number | Quality code |
description | String | Human-readable quality description |
birth_date | Object | |
flag | String | Quality flag |
code | Number | Quality code |
description | String | Human-readable quality description |
birth_place | Object | |
flag | String | Quality flag |
code | Number | Quality code |
description | String | Human-readable quality description |
address | Object | Quality results by address component. |
locality | Object | Quality of locality or city matching. |
flag | String | Quality flag. |
code | Number | Quality code. |
description | String | Human-readable quality result. |
street | Object | Quality of street matching. |
flag | String | Quality flag. |
code | Number | Quality code. |
description | String | Human-readable quality result. |
hn | Object | Quality of house-number matching. |
flag | String | Quality flag. |
code | Number | Quality code. |
description | String | Human-readable quality result. |
vat_number | Object | |
flag | String | Quality flag |
code | Number | Quality code |
description | String | Human-readable quality description |
system | Object | Request processing status. |
ret_code | Number | Processing result code. 0 means no blocking error. |
des_ret_code | String | Human-readable processing result. |
curl -X POST "https://{host}:{port}/Egon/api/norm" \
-H "token: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"par": {
"iso3": "ITA",
"geo": "S"
},
"data": {
"address": {
"city": "Verona",
"street": "Via pacinotti 4b"
}
}
}'