--- title: "Een nieuwe lijst, uit adressen of een bestand." method: POST path: "/Api/Lijst" tags: ["Lijst"] --- # Een nieuwe lijst, uit adressen of een bestand. `POST /Api/Lijst` ## Request - Base URL: `https://woz-api.nl` - URL: `https://woz-api.nl/Api/Lijst` - Auth: API key in header `X-Api-Key` Geef de adressen mee in `adressen`, elk als tekst ("Spuistraat 36C, 1012 TT Amsterdam") of als object met straat, huisnummer, huisletter, toevoeging, postcode en plaats; `ref` en `jaar` per adres mogen erbij. Of stuur een Excel- of CSV-bestand in base64 in `bestand`, met `bestandsnaam`. Hebben de adressen geen postcode of plaats, geef dan `plaats` mee. Daarna loopt de gratis proef: we zoeken alle adressen op en vragen er vijf op. Vraag de stand op met GET op links.status, met ?wacht=20 om te wachten tot hij klaar is. Dezelfde lijst binnen een uur opnieuw sturen geeft dezelfde lijst terug. ## Request body - LijstAanvraag: Een nieuwe lijst: adressen, of een bestand in base64. - `adressen` LijstAdres[], nullable: De adressen, elk als tekst ("Spuistraat 36C, 1012 TT Amsterdam") of als object met straat, huisnummer, huisletter, toevoeging, postcode, plaats, en eventueel ref en jaar. - `tekst` string, nullable: Het hele adres als tekst. Wint van de losse velden als beide er zijn. - `straat` string, nullable - `huisnummer` string, nullable - `huisletter` string, nullable - `toevoeging` string, nullable - `postcode` string, nullable - `plaats` string, nullable - `ref` string, nullable: Een eigen kenmerk van de gebruiker (objectnummer, regelnummer); komt terug in het bestand. - `jaar` string, nullable: Een jaartal per adres, voor de keuze "per rij uit een kolom" op de betaalpagina. - `bestand` string, nullable: Een Excel- of CSV-bestand in base64, in plaats van adressen. - `bestandsnaam` string, nullable: Naam van dat bestand, met extensie (.xlsx, .xls of .csv). - `plaats` string, nullable: De plaats voor alle adressen zonder postcode of plaats. "Kerkstraat 12" bestaat in veel plaatsen. - `email` string, nullable: Het eigen e-mailadres van de gebruiker voor de levering; alvast ingevuld op de betaalpagina. ## Response `200` De lijst en zijn stand. - LijstAntwoord: De stand van een lijst. Elk veld dat in deze stand niets zegt, ontbreekt. - `token` string, nullable: Het token van de lijst: wie het heeft, kan de lijst lezen en betalen. Niet in een URL voor derden zetten. - `status` string, nullable: kolommen_kiezen, proef_bezig, niets_herkend, wacht_op_betaling, bezig, klaar of mislukt. - `volgendeStap` LijstVolgendeStap - `code` string, nullable: Vaste code om op te beslissen: kolom_kiezen, wachten, niets_herkend, betaallink_geven, verwerken, klaar, mislukt. - `tekst` string, nullable - `avg` string, nullable: Hoe de gebruiker met de uitkomst omgaat. - `aantallen` LijstAantallen - `rijen` integer: Regels in de lijst, lege meegeteld. - `uniek` integer: Verschillende adressen; een dubbel adres telt en kost een keer. - `herkend` integer, nullable - `nietGevonden` integer, nullable - `geenWoz` integer, nullable - `mislukt` integer, nullable - `gevonden` integer, nullable: Met een WOZ-waarde in het resultaat; pas na de verwerking. - `proef` LijstProefRij[], nullable - `rij` integer, nullable: Positie in de lijst, vanaf 1; leeg bij een proef van voor 27 september 2026. - `invoer` string, nullable - `adres` string, nullable: Het adres zoals wij het vonden. - `status` string, nullable: gevonden, geen_woz, niet_gevonden of mislukt. - `wozWaarde` integer, nullable - `wozJaar` integer, nullable: Het belastingjaar van die waarde: peildatum 1 januari 2025 is WOZ-jaar 2026. - `peildatum` string, nullable - `prijs` LijstPrijs - `adressen` integer: Het aantal adressen dat de gebruiker betaalt: alle herkende, de proefadressen inbegrepen. - `prijsPerAdresExclBtw` number, double, nullable - `exclBtw` number, double - `btw` number, double - `inclBtw` number, double - `valuta` string, nullable - `uitleg` string, nullable - `betaling` LijstBetaling - `betaalUrl` string, nullable: De pagina waar de gebruiker de proef ziet en zelf met iDEAL betaalt. Openen start nog geen betaling. - `emailBekend` boolean: Of er al een e-mailadres voor de levering is; zo niet, dan vraagt de betaalpagina erom. - `uitleg` string, nullable - `voortgang` LijstVoortgang - `verwerkt` integer - `totaal` integer - `geschatKlaarOp` string, date-time, nullable: Een schatting; lijsten worden een voor een verwerkt. - `kolommen` LijstKolommen: Bij een bestand waarvan we de adreskolom niet zeker wisten: de kolommen en een paar regels. - `lijst` LijstKolom[], nullable - `index` integer - `naam` string, nullable - `voorbeeld` array[], nullable: De eerste regels onder de kop, om de kolom te kunnen kiezen. - string[] - `voorstel` LijstKolomKeuze: De kolomkeuze bij een bestand waarvan we de adreskolom niet zeker wisten. Kolommen tellen vanaf 0. - `adres` integer, nullable: De kolom met het hele adres. Dan zoeken wij de postcode- en plaatskolom erbij. - `straat` integer, nullable - `huisnummer` integer, nullable - `huisletter` integer, nullable - `toevoeging` integer, nullable - `postcode` integer, nullable - `plaats` integer, nullable - `kopregel` integer, nullable: De rij met kolomnamen (vanaf 0), of -1 als het bestand er geen heeft. Leeg: zoals we hem vonden. - `vastePlaats` string, nullable: De plaats voor alle adressen, als het bestand geen postcode en geen plaats heeft. - `plaatsNodig` boolean: Of het bestand geen postcode en geen plaats heeft; geef dan vastePlaats mee. - `links` LijstLinks - `status` string, nullable: Deze stand opnieuw opvragen. - `pagina` string, nullable: De pagina voor de gebruiker zelf, met proef, betalen en download. - `kolommen` string, nullable - `betaallink` string, nullable - `resultaten` string, nullable - `download` string, nullable - `volgendeControleNaSeconden` integer, nullable: Na zoveel seconden is er waarschijnlijk iets veranderd; leeg als er niets te wachten valt. - `aangemaaktOp` string, date-time - `geleverdOp` string, date-time, nullable - `apiToegangTot` string, date-time, nullable: Tot wanneer de API deze lijst nog toont; de link uit de bezorgmail blijft daarna werken. ## Other responses - `400`: Onbruikbare invoer (InvalidInput, TeVeelAdressen, EmailOngeldig). - `401`: Geen sleutel in de header (SleutelOntbreekt) of een verlopen proefsleutel (SleutelVerlopen). - `403`: Een OAuth-token (ScopeOntbreekt). - `429`: Vandaag al genoeg lijsten met deze sleutel, of de gratis proeven zijn vol (TeVeelLijsten). --- [API](https://skmtc.dev/woz-api/apis/wozapi.md) · [All operations](https://skmtc.dev/woz-api/apis/wozapi/llms.txt) · [OpenAPI document](https://skmtc.dev/woz-api/apis/wozapi/revisions/0b2d268e221d?raw)