POST/v1/portefeuille

Portefeuille (batch) — API-endpoint

Start een batchwaardering voor een lijst adressen. De opdracht wordt asynchroon verwerkt; u haalt het resultaat op met het opdracht-ID of ontvangt een webhook.

Parameters

Naam	Type	Verplicht	Beschrijving
objecten	array	Ja	Lijst met objecten: postcode, huisnummer en optioneel eigen_id.
onderdelen	array	Nee	Welke onderdelen per object: waarde, kenmerken, energie, groene_waarde. Standaard waarde.
webhook_url	string	Nee	URL die wordt aangeroepen als de opdracht klaar is.

Bij dit endpoint stuurt u de parameters als JSON in de request-body.

Voorbeeld-request

cURL

curl -X POST "https://api.dometrum.nl/v1/portefeuille" \
  -H "X-API-Key: UW_API_SLEUTEL" \
  -H "Content-Type: application/json" \
  -d '{
  "objecten": [
    {
      "eigen_id": "OBJ-001",
      "postcode": "3511AB",
      "huisnummer": 12
    },
    {
      "eigen_id": "OBJ-002",
      "postcode": "3512CD",
      "huisnummer": 4
    }
  ],
  "onderdelen": [
    "waarde",
    "groene_waarde"
  ],
  "webhook_url": "https://uw-domein.nl/dometrum/webhook"
}'

Voorbeeld-response

200 OK · application/json

{
  "opdracht_id": "pf_7f3a9c",
  "status": "in_behandeling",
  "aantal_objecten": 2,
  "aangemaakt_op": "2026-10-28T09:12:00Z",
  "resultaat_url": "https://api.dometrum.nl/v1/portefeuille/pf_7f3a9c"
}

Velden

opdracht_id string: Uniek ID van de batchopdracht.
status string: in_behandeling, gereed of mislukt.
resultaat_url string: GET-URL waar het resultaat beschikbaar komt.