Skip to main content

Validation Services

Tax Code Extraction

Extract gender, date of birth, and place of birth (city and province) from an Italian tax code (Codice Fiscale), with a quality flag.

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, `taxfnx` function `5`, and tax code to decode.

FieldTypeDescription
parreq
Object

Country context and tax-code extraction function.

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.

taxfnxreq
String

Tax-code configuration function.

  • 5 Extract demographic information from tax code

Default value: 5

datareq
Object

Input data to validate

tax_codereq
Object

Italian tax code to extract demographics from

cod_iso3
String

Country code (ISO 3166-1 alpha-3)

cod_type
String

Type of code

cod_descriptionreq
String

Italian tax code to extract info from

Response​

Extracted birth date, birth province, birth city, quality indicator, and system status.

FieldTypeDescription
data
Object

Normalized and enriched validation output data

name
Object

Extracted demographic and birthplace data

gender
String

Extracted gender

birth_date
String

Extracted date of birth in YYYYMMDD format

birth_province
String

Extracted birth province code

birth_place
String

Extracted birth city description

quality
Object

Validation quality indicators and score flags

tax_code
Object

Quality indicator result (see https://documentation.egon.com/docs/quality-indicators)

flag
String

Quality flag

code
Number

Quality result code

description
String

Quality result 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",
"taxfnx": "5"
},
"data": {
"tax_code": {
"cod_iso3": "ITA",
"cod_type": "01110",
"cod_description": "RSSMRA93B19L781K"
}
}
}'