.. _configuration_prefill_bag:

===
BAG
===

The BAG (Basisregistratie Adressen en Gebouwen) is a database from the
`Kadaster`_ containing address information, that can be accessed via the
semi-public `BAG API`_. Open Forms can be configured to access this API to
autocomplete addresses.

.. _`Kadaster`: https://www.kadaster.nl/


Configuration
=============

1. Obtain a `BAG API key`_ from Kadaster.
2. In Open Forms, navigate to: **Configuration** > **Services**
3. Click **Add service** and fill in the following details:

   * **Label**: BAG (Kadaster)
   * **Type**: ORC (Overige)
   * **API root URL**: ``https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2/``
   * **Authorization type**: API key
   * **Header key**: X-Api-Key
   * **Header value**: *The BAG API key obtained in step 1*

4. Click **Save**
5. Navigate to **Configuration** > **Overview**. In the **Address lookup plugins**
   group, click on **Configuration** for the **Kadaster API: BAG** line.
6. Select for the **BAG service**, the **[ORC (Overige)] BAG (Kadaster)**
   option, that we just created in step 3.
7. Click **Save**

The BAG configuration is now complete. You can refresh the configuration overview page
to do a connection check.

.. _`BAG API`: https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2/openapi.yaml
.. _`BAG API key`: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen


Technical
=========

================  ===================
API               Supported versions
================  ===================
BAG API           2.0
================  ===================