Skip to content

API-documentatie

v1.0.0

Portefeuille matchen

POST /api/v1/portfolio/match

scope: portfolio:match 0.1 credit per KvK-nummer

Controleer welke KvK-nummers bij een openbaar faillissement horen. Alleen exacte KvK-matches; de nummers worden niet opgeslagen.

Body

Body
NaamTypeOmschrijving
kvk_numbers verplicht

KvK-nummers van 8 cijfers

string[]KvK-nummers van 8 cijfers

Antwoord, HTTP 200

Antwoord, HTTP 200

Antwoord, HTTP 200
NaamTypeOmschrijving
data verplicht object[]
data[].kvk_number verplicht string
data[].matched verplicht string
data[].cases verplicht string
meta verplicht object
meta.numbers verplicht integer
meta.matched verplicht integer
meta.credits verplicht number

Antwoord, HTTP 422

Validation error

Antwoord, HTTP 422

Antwoord, HTTP 422
NaamTypeOmschrijving
error verplicht object
error.code verplicht

Stable error code, for example not_found or validation_failed

stringStable error code, for example not_found or validation_failed
error.message verplicht

Human-readable explanation

stringHuman-readable explanation
error.details

Extra information, such as the fields that failed validation

objectExtra information, such as the fields that failed validation

De velden van het antwoord staan in openapi.json. Hoe elke waarde met bron is opgebouwd, leest u bij Gegevens en brondocumenten