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.


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 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-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 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 `0` 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

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 Swedish postal codes.


This will give autocomplete suggestions for Austria postal codes.


This will give autocomplete suggestions for settlements.


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 Swedish settlements.


This will give autocomplete suggestions for Austria settlements.


This will give autocomplete suggestions for streets.


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


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

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


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`


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 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 Belgian post boxes.

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


Plugins de Validation d'Adresse pour Boutiques en Ligne

webshop

Plugins disponibles