Validates that an address with the provided fields exists, and provides additional information about it.

If you do not have all required parameters, use the [suggest](#tag/Suggest-BE) call to gather them first.

If the input identifies a unique address, all available information
about that address is returned. The default street, settlement,
province will be in the language spoken for that region. E.g: For
settlement, province and region in Flanders the default is Dutch.
In Wallonia the default language spoken is French, except for German
speaking parts where the default is German.

* To validate if an address has either a street number or a premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain street number, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.


The address's postal code which consists of four digits.


postalCode

Belgium postalCode

street

The address's street number and premise (extension/addition).


streetNumberAndPremise

streetNumber

premise

The box identifier, excluding any prefixes such as "box", "bus", "bte", or "boîte". If provided, these prefixes will be automatically removed.


The request is rejected; `error_id` names the reason.


The request is not authorized; `error_id` names the reason.


Nothing matches the request; `error_id` names the reason.


Validates that an address with the provided fields exists, and provides additional information about it.

If you do not have all required parameters, use the [suggest](#tag/Suggest-DE) call to gather them first.

If the input identifies a unique address, all available information
about that address is returned.

* To validate if an address has either a street number or a premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain street number, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.


The address's postal code which consists of five digits.


German postalCode

The address's settlement (city, town, village, or hamlet).


settlement

Validates that an address with the provided fields exists, and provides additional information about it.

If you do not have all required parameters, use the [suggest](#tag/Suggest-NL) call to gather them first.

If the input identifies a unique address, all available information
about that address is returned.

* To validate if an address has either a street number or a premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain street number, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.

The specials subscription includes additional return fields: `BAGNumberId`, `BAGPublicSpaceId`,
`BAGPremiseId`, `BAGResidenceId`, `BAGType`, `neighbourhood`, `district` and `plotSize`.


The address's postal code in sixpp format (`1000AA`).


Dutch sixpp postalCode

Validates that an address with the provided fields exists, and provides additional information about it.

If you do not have all required parameters, use the [suggest](#tag/Suggest-LU) call to gather them first.

If the input identifies a unique address, all available information
about that address is returned.

* To validate if an address has either a street number or a premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain street number, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.


Luxembourg postalCode

Validates that an address with the provided fields exists, and provides additional information about it.

If you do not have all required parameters, use the [suggest](#tag/Suggest-FR) call to gather them first.

If the input identifies a unique address, all available information
about that address is returned.

* To validate if an address has either a street number or a premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain street number, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.


French postalCode

Validates that an address with the provided fields exists, and provides additional information about it.

If you do not have all required parameters, use the [suggest](#tag/Suggest-DK) call to gather them first.

If the input identifies a unique address, all available information
about that address is returned.

* To validate if an address has either a street number or a premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain street number, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.


Danish postalCode

Validates that an address with the provided fields exists, and provides additional information about it.

If you do not have all required parameters, use the [suggest](#tag/Suggest-AT) call to gather them first.

If the input identifies a unique address, all available information
about that address is returned.

* To validate if an address has either a street number or a premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain street number, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.

Austrian house numbers are the source's labels and are returned as
strings, such as `"1"`, `"6-8"` or `"A"`. Every address from the
Austrian dataset carries its source `addressId` and, where the source
designates the building (`Wohnhaus`, `Hauptgebäude`, `Bau 1`), its
`buildingName`.

* When the fields describe several source addresses (several buildings
  at one house number, for instance), the response is a 400 that lists
  their `addressId` values; select one by its location or building
  name and retry with `addressId`.
* An `addressId` alone resolves that exact address. Fields sent along
  with it must match the selected address.


Austrian postalCode

The `addressId` of an address-level suggestion. It selects that one source
address, including an address without a house number, and is required when
the other fields describe several addresses. Any other field sent along with
it is checked against the selected address.


addressId

Validates that an address with the provided fields exists, and provides additional information about it.

If you do not have all required parameters, use the [suggest](#tag/Suggest-CH) call to gather them first.

If the input identifies a unique address, all available information
about that address is returned.

* To validate if an address has either a street number or a premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain street number, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.

Swiss house numbers are the source's labels and are returned as strings,
such as `"30"`, `"4.1"` or `"2bis.1"`. Every address from the Swiss
dataset carries its source `addressId` and, where the source names the
building, its `buildingName`. An address you added yourself through
[feedback](#tag/Feedback-CH) has no source record, so it carries
neither.

* When the fields describe several source addresses (two entrances of
  one house number, for instance), the response is a 400 that lists
  their `addressId` values; select one by its location or building
  name and retry with `addressId`.
* An `addressId` alone resolves that exact address, including an
  address without a house number. Fields sent along with it must match
  the selected address.


Swiss postalCode

Validates that an address with the provided fields exists, and provides additional information about it.

If you do not have all required parameters, use the [suggest](#tag/Suggest-ES) call to gather them first.

If the input identifies a unique address, all available information
about that address is returned.

* To validate if an address has either a street number or a premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain street number, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.

Spanish house numbers are the source's labels and are returned as
strings, such as `"1"`, `"03"` or `"S-N"` (sin número). A padded number is a
different address from its unpadded spelling. Every address from the
Spanish dataset carries its source `addressId`; its `buildingName` is
always null, as the source names no buildings.

* When the fields describe several source addresses (two portals of
  one house number, for instance), the response is a 400 that lists
  their `addressId` values; select one by its location and retry with
  `addressId`.
* An `addressId` alone resolves that exact address. Fields sent along
  with it must match the selected address.


Spanish postalCode

Validates that an address with the provided fields exists, and provides additional information about it.

If you do not have all required parameters, use the [suggest](#tag/Suggest-GB) call to gather them first.

If the input identifies a unique address, all available information
about that address is returned.

* To validate if an address has either a street number or a premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain street number, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.

British house numbers are the source's labels and are returned as
strings, such as `"1"` or a complete range like `"81-87"`. Every
address from the British dataset carries its source `addressId` and,
where the source names the building (`addr:housename`), its
`buildingName`.

* When the fields describe several source addresses (two buildings of
  one house number, for instance), the response is a 400 that lists
  their `addressId` values; select one by its location or building
  name and retry with `addressId`.
* An `addressId` alone resolves that exact address. Fields sent along
  with it must match the selected address.

Note: the GB country code denotes the United Kingdom (ISO 3166-1 GB). Address data coverage is currently limited to England; Scotland, Wales and Northern Ireland are not yet included and will be added as coverage expands.


The address's postal code: a complete unit postcode such as `B1 2JB`, with or
without the space.


British postalCode

Official German and Slovene settlement names match canonical Italian source addresses.

Validates that an address with the provided fields exists, and provides additional information about it.

If you do not have all required parameters, use the [suggest](#tag/Suggest-IT) call to gather them first.

If the input identifies a unique address, all available information
about that address is returned.

* To validate if an address has either a street number or a premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain street number, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.

Italian house numbers are the source's civic numbers (civico) and are
returned as strings, such as `"12"`, or `"12R"` for the red series that
Genova, Firenze and Savona number apart from the black one. The exponent
(esponente) of a house number, such as `"A"`, `"BIS"` or `"1"`, is its
`premise`. Every address from the Italian dataset carries its source
`addressId`; its `buildingName` is always null, as the source names no
buildings.

* When the fields describe several source addresses (two entrances of
  one house number, for instance), the response is a 400 that lists
  their `addressId` values; select one by its location and retry with
  `addressId`.
* An `addressId` alone resolves that exact address. Fields sent along
  with it must match the selected address.


The address's postal code (CAP) which consists of five digits.


Italian postalCode

webshop

regular

dev_agency

specials

Returns postal code suggestions for a partly typed `postalCode`.


The partial postalCode contains at least 1 digit.


Partial postalCode

The amount of results returned, a number between `1` and `999`. Default value is `10`.


maxResults

The page to return, the variables for the next/previous pages can be found in the results Link header.


cursor

Postal code suggestions, or an empty array when nothing matches


The partial postalCode starts with a letter, with or without the space.


Returns settlement suggestions for a partly typed `settlement`.


Either the fourpp (e.g: `1000`) or the sixpp (e.g: `1000AA`) notation.


Dutch postalCode

Settlement suggestions, or an empty array when nothing matches


Returns settlement suggestions for a partly typed `settlement`.

### How it works

- Suggestions are generated from **postnames**.
  A postname is the official postal designation used by Bpost, which may differ from the administrative municipality or deelgemeente.
  For example, **Laken** is a postname within the municipality of **Brussels**.

- If the `languageCode` parameter is omitted, results are returned in the **country default language**.
- If the `languageCode` parameter is specified but no matches exist in that language, the API will fall back to the **country default language**.

- `postalCode` or `settlement` is required.


ISO 639-1 language code used to determine the language context for input filters.

- **When specified**: input filters are applied only within the given language.
- **When unspecified**: the **default value** is `'nl'` (Dutch).


languageCode

The address's settlement (city, town, village).


Official German and Slovene settlement names match canonical Italian source addresses.

Returns settlement suggestions for a partly typed `settlement`.


Returns street suggestions for a partly typed `street`.


Street suggestions, or an empty array when nothing matches


When specified, this ISO 639-1 language code determines in which language the accompanied input filters will be applied. It does not affect the output languages. When unspecified, input filters are applied to all languages.


Returns street number and premise suggestions for a partly typed `streetNumberAndPremise`.

* `postalCode`, or `street` with `settlement`, is required.


Street number and premise suggestions, or an empty array when nothing matches


Returns street number and premise suggestions for a partly typed `streetNumberAndPremise`.

* `postalCode`, `settlement` and `street` are all required.


Returns street number and premise suggestions for a partly typed `streetNumberAndPremise`.

* `street` is required, with either `postalCode` or `settlement`.


Returns street number and premise suggestions for a partly typed `streetNumberAndPremise`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-CH), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns street number and premise suggestions for a partly typed `streetNumberAndPremise`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-AT), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns street number and premise suggestions for a partly typed `streetNumberAndPremise`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-ES), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns street number and premise suggestions for a partly typed `streetNumberAndPremise`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-GB), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns street number and premise suggestions for a partly typed `streetNumberAndPremise`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-IT), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns street number suggestions for a partly typed `streetNumber`.

* `postalCode`, or `street` with `settlement`, is required.


Street number suggestions, or an empty array when nothing matches


Returns street number suggestions for a partly typed `streetNumber`.

* `postalCode`, `settlement` and `street` are all required.


Returns street number suggestions for a partly typed `streetNumber`.

* `street` is required, with either `postalCode` or `settlement`.


Returns street number suggestions for a partly typed `streetNumber`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-CH), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns street number suggestions for a partly typed `streetNumber`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-AT), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns street number suggestions for a partly typed `streetNumber`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-ES), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns street number suggestions for a partly typed `streetNumber`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-GB), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns street number suggestions for a partly typed `streetNumber`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-IT), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns premise suggestions for a partly typed `premise`.

* `postalCode`, or `street` with `settlement`, is required.


Premise suggestions, or an empty array when nothing matches


Returns premise suggestions for a partly typed `premise`.

* `postalCode`, `settlement` and `street` are all required.


Returns premise suggestions for a partly typed `premise`.

* `street` is required, with either `postalCode` or `settlement`.


Returns premise suggestions for a partly typed `premise`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-CH), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns premise suggestions for a partly typed `premise`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-AT), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns premise suggestions for a partly typed `premise`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-ES), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns premise suggestions for a partly typed `premise`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-GB), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns premise suggestions for a partly typed `premise`.

* `street` is required, with either `postalCode` or `settlement`.

Each suggestion names one source address: `addressId` selects it in
[autocomplete](#tag/Autocomplete-IT), also where several addresses share
the fields, and `buildingName` is the building's name where the source has one.


Returns post box suggestions for a partly typed `box`.

* `street` is required, with either `postalCode` or `settlement`.


Box suggestions, or an empty array when nothing matches


Ottimizzi il checkout del Suo webshop con le API di validazione indirizzi e autocompletamento indirizzi

webshop

Plugin disponibili