Skip to content

Address Check

Full address validation with automatic correction suggestions.

Method: addressCheck

API KeyNot set

Stored in localStorage — never sent to this site.

Parameters
Street format:
ISO 3166-1 Alpha-2
Optional fields:
House-number-first countries (78)

In the following countries the house number is placed before the street name (e.g. "10 Downing Street" rather than "Downing Street 10"):

AD, AM, AU, AZ, BD, BH, BL, BN, CA, CC, CD, CG, CI, CK, CN, CX, CY, DM, DZ, EG, FJ, FR, GA, GB, GE, GH, GI, GM, GP, GU, GY, HK, ID, IE, IL, IN, KH, KN, LA, LB, LU, MA, MC, MF, MM, MR, MS, MU, NA, NF, NG, NZ, OM, PH, PK, PR, PW, RE, RW, SA, SG, SH, SL, SN, TC, TG, TH, TM, TN, TT, TW, TZ, US, VM, WF, YE, ZM, ZW

Request Preview
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "addressCheck",
  "params": {}
}
Set an API key above to enable live requests.

Parameters

FieldRequiredTypeDescription
countryYesStringISO 3166-1 Alpha-2 country code (e.g. DE)
postCodeYesStringPostal code
cityNameYesStringCity name
streetFullNo*StringStreet + house number combined (e.g. Hauptstr. 22)
streetNo*StringStreet name only
houseNumberNo*StringHouse number only
additionalInfoNoStringAddress supplement. Send "" to include in response.
subdivisionCodeNoStringState/region code (e.g. DE-BY). Send "" to auto-fill.
languageNoStringOutput language (e.g. de).

*Either streetFull or (street + houseNumber) is required.

Response

json
{
  "result": {
    "predictions": [
      {
        "country": "de",
        "postCode": "97232",
        "cityName": "Giebelstadt",
        "street": "Lindenstr.",
        "houseNumber": "28",
        "additionalInfo": "",
        "subdivisionCode": "DE-BY"
      }
    ],
    "status": [
      "address_needs_correction",
      "country_code_correct",
      "postal_code_correct",
      "locality_correct",
      "street_name_needs_correction",
      "street_name_minor_correction",
      "building_number_correct"
    ]
  }
}

Status Codes

Core Result

CodeMeaningAction
address_correctAddress is correctNo action needed
address_needs_correctionCorrection in predictionsApply based on severity
address_multiple_variantsMultiple valid variantsShow to user for selection
address_not_foundNot in databaseManual review
address_of_not_supported_typee.g. PackstationInform user

Severity (auto-adopt vs manual)

CodeAuto-adopt?Meaning
address_minor_correctionYesSmall fix, safe to apply automatically
address_major_correctionNoCritical change, user must confirm
[field]_minor_correctionYesField-level minor fix
[field]_major_correctionNoField-level critical change

Decision Logic

address_correct                      → no action
address_needs_correction
  + address_minor_correction only   → auto-adopt predictions
  + any _major_correction           → show user for confirmation
address_multiple_variants            → user picks one
address_not_found                    → manual review

Per-Field Codes

Each field returns a pair: [field]_correct or [field]_needs_correction.

PrefixField
country_code_Country
postal_code_Postal code
locality_City name
street_name_Street name
building_number_House number
additional_info_Address supplement
subdivision_code_State/region

Examples

Street + number split

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "addressCheck",
  "params": {
    "country": "DE",
    "language": "de",
    "postCode": "97232",
    "cityName": "Giebelstadt",
    "street": "Lindenstraße",
    "houseNumber": "28"
  }
}

Combined street

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "addressCheck",
  "params": {
    "country": "DE",
    "language": "de",
    "postCode": "97232",
    "cityName": "Giebelstadt",
    "streetFull": "Lindenstraße 28"
  }
}

With subdivision code

Send subdivisionCode: "" to have the API auto-fill it:

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "addressCheck",
  "params": {
    "country": "DE",
    "postCode": "97232",
    "cityName": "Giebelstadt",
    "street": "Lindenstraße",
    "houseNumber": "28",
    "subdivisionCode": ""
  }
}

The response will include subdivisionCode: "DE-BY" and status codes subdivision_code_needs_correction + subdivision_code_minor_correction — this is expected, not an error.

Endereco JSON-RPC API