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

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-BE) call to gather them first.

If the input identifies a unique address, all available information
about said 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 can be up to four digits long.


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.


A required field is missing or a value is invalid


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

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-DE) call to gather them first.

If the input identifies a unique address, all available information
about said 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 can be up to five digits long.


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.

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-NL) call to gather them first.

If the input identifies a unique address, all available information
about said 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, which are:

* `BAG_NUM_ID`
* `BAG_OPR_ID`
* `BAG_PND_ID`
* `BAG_VBO_ID`
* `BAG_TYPE`
* `neighbourhood`
* `district`
* `plotSize`


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


Dutch postalCode

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

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-LU) call to gather them first.

If the input identifies a unique address, all available information
about said 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.

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-FR) call to gather them first.

If the input identifies a unique address, all available information
about said 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.


French postalCode

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

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-DK) call to gather them first.

If the input identifies a unique address, all available information
about said 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 four digits.


Danish postalCode

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

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-AT) call to gather them first.

If the input identifies a unique address, all available information
about said 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.

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-CH) call to gather them first.

If the input identifies a unique address, all available information
about said 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 the input identifies a unique address, all available information
about said 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 the input identifies a unique address, all available information
about said 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

webshop

regular

dev_agency

specials

This will give autocomplete suggestions for postal codes.


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 suggestion(s) available, or an empty array when nothing matches


This will give autocomplete suggestions for Belgian postal codes.


This will give autocomplete suggestions for French postal codes.


This will give autocomplete suggestions for Luxembourg postal codes.


This will give autocomplete suggestions for Danish postal codes.


This will give autocomplete suggestions for Swiss postal codes.


This will give autocomplete suggestions for Austria postal codes.


This will give autocomplete suggestions for Spanish postal codes.


This will give autocomplete suggestions for British postal codes.


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


This will give autocomplete suggestions for settlements.


Settlement suggestion(s) available, or an empty array when nothing matches


Provides autocomplete suggestions for Belgian settlements.

### 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**.

- Either the `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

This will give autocomplete suggestions for French settlements.


This will give autocomplete suggestions for Luxembourg settlements.


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


This will give autocomplete suggestions for Danish settlements.


This will give autocomplete suggestions for Swiss settlements.


This will give autocomplete suggestions for Austria settlements.


This will give autocomplete suggestions for Spanish settlements.


This will give autocomplete suggestions for British settlements.


This will give autocomplete suggestions for streets.


street suggestion(s) available, or an empty array when nothing matches


This will give autocomplete suggestions for Belgian streets.


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.


This will give autocomplete suggestions for French streets.


This will give autocomplete suggestions for Danish streets.


This will give autocomplete suggestions for Swiss streets.


This will give autocomplete suggestions for Austrian streets.


This will give autocomplete suggestions for Luxembourg streets.


This will give autocomplete suggestions for Spanish streets.


This will give autocomplete suggestions for British streets.


This will give autocomplete suggestions for Dutch
streetnumber and premise (extension/addition).

No specific parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `street` and `settlement`


premise suggestion(s) available, or an empty array when nothing matches


This will give autocomplete suggestions for German
streetnumber and premise (extension/addition).


This will give autocomplete suggestions for Belgian
streetnumber and premise (extension/addition).

Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for French
streetnumber and premise (extension/addition).

Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Luxembourg
streetnumber and premise (extension/addition).

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`

A request cannot be only a streetNumberAndPremise


This will give autocomplete suggestions for Swiss
streetnumber and premise (extension/addition).

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`

A request cannot be only a streetNumberAndPremise

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.


This will give autocomplete suggestions for Danish
streetnumber and premise (extension/addition).

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`

A request cannot be only a streetNumberAndPremise


This will give autocomplete suggestions for Austrian
streetnumber and premise (extension/addition).

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`

A request cannot be only a streetNumberAndPremise

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.


This will give autocomplete suggestions for Spanish
streetnumber and premise (extension/addition).

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`

A request cannot be only a streetNumberAndPremise

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.


This will give autocomplete suggestions for British
streetnumber and premise (extension/addition).

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`

A request cannot be only a streetNumberAndPremise

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.


This will give autocomplete suggestions for streetnumbers.

No specific parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `street` and `settlement`


streetnumber suggestion(s) available, or an empty array when nothing matches


This will give autocomplete suggestions for streetnumbers.


This will give autocomplete suggestions for Belgian streetnumbers.

Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for French streetnumbers.

Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Swiss street numbers.
Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `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.


This will give autocomplete suggestions for Danish street numbers.
Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Austrian street numbers.
Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `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.


This will give autocomplete suggestions for Luxembourg streetnumbers.

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Spanish street numbers.
Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `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.


This will give autocomplete suggestions for British street numbers.
Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `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.


This will give autocomplete suggestions for premises.

No specific parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `street` and `settlement`


This will give autocomplete suggestions for premises.


This will give autocomplete suggestions for Belgian premises.

Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for French premises.

Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Luxembourg premises.

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Swiss premises.

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `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.


This will give autocomplete suggestions for Danish premises.

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Austrian premises.

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `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.


This will give autocomplete suggestions for Spanish premises.

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `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.


This will give autocomplete suggestions for British premises.

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `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.


This will give autocomplete suggestions for Belgian post boxes.

Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


Test Unser Österreich Überprüfung der Adresse API mit interaktiven Live-Demos