Skip to main content

Validation Services

Address

The Address endpoint validates and normalizes an address, returning the street, house number, postal data, Egon codes, and geographic coordinates.

Endpoint​

POSThttps://{host}:{port}/Egon/api/norm

Headers & authentication​

Required request headers and their expected values.

FieldTypeDescription
tokenreq
String

Authentication token sent in the token request header.

Request​

Country context, processing options, and address fields to validate.

FieldTypeDescription
parreq
Object

Processing options and country context for address validation.

iso2
String

Country code, ISO 3166-1 alpha-2.

One of iso2 or iso3 is required.

iso3
String

Country code, ISO 3166-1 alpha-3.

One of iso2 or iso3 is required.

geo
String

Activate geocoding.

  • N No
  • S Yes

Default value: N

fmtout
String

Output format.

  • C Capitalized
  • M Upper case
  • T Upper case with apostrophes instead of accents
  • X Upper case without accents

Default value: C

fmtsht
String

Activate short descriptions.

  • N No
  • S Yes

Default value: N

lngout
String

Output language.

  • NAT Native output language
  • TRA Transliterated output language
  • INT International or English output language
  • <empty> Keep the input language
tpxout
String

Output description format.

  • LAT Latinized output without accents
hn_code
String

Activate Egon house-number codes.

Default value: S

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.

FieldTypeDescription
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.

short
Object

Short descriptions, returned when par.fmtsht is enabled.

smart
Object

Simplified address representation.

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
birth_date
Object
birth_place
Object
address
Object

Quality results by address component.

locality
Object

Quality of locality or city matching.

street
Object

Quality of street matching.

hn
Object

Quality of house-number matching.

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.

Request Example
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"
}
}
}'