achtcijfersMerk

Aan de slag

Het merk in code

Hoe het merk terugkomt in de API.

Taal

Veldnamen, endpoints, codes en enumwaarden zijn Engels, in snake_case. De uitleg in de docs en de foutberichten zijn Nederlands. Nooit door elkaar in één naam.

Het KVK-nummer eerst

Het eerste voorbeeld in de docs, op de site en in elke snelstart is een bedrijf ophalen op zijn nummer:

GET /v1/companies/{kvk_number}

Het domein is een gelijkwaardige tweede ingang, direct eronder en niet weggestopt:

GET /v1/companies?domain=voorbeeld.nl

Daarna volgen zoeken (GET /v1/companies) en verrijken in bulk (POST /v1/companies/enrich). De precieze endpoints legt de API-referentie vast; deze pagina legt de volgorde vast.

Voorbeeldnummers

Voorbeelden gebruiken altijd fictieve KVK-nummers uit een vaste reeks, nooit het nummer van een echt bedrijf: een eenmanszaak is een persoon. Gebruik 00000001 tot en met 00000009, met 00000001 als het nummer dat we niet kennen.

Onbekend is null

BetekenisWaarde
Bekendde waarde
Nee of nulfalse of 0
Onbekendnull

Elk bedrijf heeft een object known:

"known": { "count": 6, "total": 7, "fields": ["website", "webshop", "phone", "open_vacancies", "recent_change", "address"] }

Een getal, geen tekst als "6/7": dan kun je erop sorteren en filteren.

Notatie

  • Telefoon in E.164 (+31301234567). De interface toont 030 123 45 67.
  • Bedragen in centen als integer, met currency: "EUR".
  • Datums in ISO 8601. Nooit een datum of bron per veld.

Voorbeelden

Elk voorbeeld in de docs is een volledige response van een fictief bedrijf, met minstens één null. Afgekapte responses ([ … ]) alleen in marketing.