Naar de inhoud

API-documentatie

v1.0.0

Dossier

GET/api/v1/cases/{case}

scope: cases:read1 credits

Eén dossier met status, rechtbank, curator, kerncijfers en de herkomst van elke waarde.

Padparameters

Padparameters
NaamTypeOmschrijving
caseverplicht

Dossier-id (ULID) of de slug van het dossier

stringDossier-id (ULID) of de slug van het dossier

Antwoord · HTTP 200

Public data

Antwoord · HTTP 200

Antwoord · HTTP 200
NaamTypeOmschrijving
dataverplichtobject
data.idverplichtstring
data.slugverplichtstring
data.nameverplichtstring
data.statusverplichtstring
data.procedureverplichtstring
data.insolvency_numberverplichtstring
data.case_numberverplichtstring
data.declared_onverplichtstring
data.terminated_onverplichtstring | null
data.termination_reasonverplichtstring | null
data.kvk_numberverplichtstring | null
data.judgeverplichtstring | null
data.last_report_onverplichtstring | null
data.last_update_atverplichtstring | null
data.trade_namesverplichtstring[]
data.procedure_typeverplichtobject | null
data.procedure_type.idverplichtstring
data.procedure_type.keyverplichtstring
data.procedure_type.familyverplichtstring
data.procedure_type.nameverplichtstring | null
data.procedure_type.short_nameverplichtstring | null
data.procedure_type.legal_basisverplichtobject | null
data.procedure_type.legal_basis.nameverplichtstring
data.procedure_type.legal_basis.provisionverplichtstring | null
data.procedure_type.legal_basis.urlverplichtstring | null
data.procedure_type.featuresverplichtstring[]
data.legal_formverplichtobject | null
data.legal_form.valueverplichtstring
data.sbiverplichtobject | null
data.sbi.codeverplichtstring
data.sbi.descriptionverplichtstring | null
data.sbi.versionverplichtstring | null
data.courtverplichtobject
data.court.nameverplichtstring
data.court.slugverplichtstring
data.court.locationverplichtstring | null
data.curatorverplichtobject | null
data.curator.nameverplichtstring
data.curator.slugverplichtstring
data.curator.law_firmverplichtstring | null
data.curator.cityverplichtstring | null
data.curator.verifiedverplichtboolean
data.locationverplichtobject | null
data.location.streetverplichtstring | null
data.location.house_numberverplichtstring | null
data.location.additionverplichtstring | null
data.location.postal_codeverplichtstring | null
data.location.cityverplichtstring | null
data.location.municipalityverplichtstring | null
data.location.provinceverplichtstring | null
data.location.kindverplichtstring | null
data.location.latverplichtnumber | null
data.location.lngverplichtnumber | null
data.countsverplichtobject
data.counts.reportsverplichtinteger
data.counts.documentsverplichtinteger
data.counts.assetsverplichtinteger
data.counts.investigationsverplichtinteger
data.counts.newsverplichtinteger
data.report_countverplichtinteger
data.linkedverplichtobject
data.linked.continued_fromverplichtobject | null
data.linked.continued_from.slugverplichtstring
data.linked.continued_from.case_numberverplichtstring | null
data.linked.continued_from.procedureverplichtstring
data.linked.continued_from.courtverplichtstring | null
data.linked.continued_from.relationverplichtstring | null
data.linked.continued_asverplichtobject | null
data.linked.continued_as.slugverplichtstring
data.linked.continued_as.case_numberverplichtstring | null
data.linked.continued_as.procedureverplichtstring
data.linked.continued_as.courtverplichtstring | null
data.linked.continued_as.relationverplichtstring | null
data.valuesverplichtobject
data.values.*.fieldverplichtstring
data.values.*.kindverplichtstring
data.values.*.valueverplichtnumber | null
data.values.*.stateverplichtenum known · not_mentioned · not_known · not_reported
data.values.*.qualifierverplichtstring | null
data.values.*.as_ofverplichtstring | null
data.values.*.report_numberverplichtinteger | null
data.values.*.report_dateverplichtstring | null
data.values.*.sourceverplichtobject | null
data.values.*.source.documentverplichtobject | null
data.values.*.source.document.idverplichtstring
data.values.*.source.document.titleverplichtstring | null
data.values.*.source.document.report_numberverplichtinteger | null
data.values.*.source.document.report_dateverplichtstring | null
data.values.*.source.document.published_onverplichtstring | null
data.values.*.source.document.page_countverplichtinteger | null
data.values.*.source.document.urlverplichtstring | null
data.values.*.source.document.sha256verplichtstring | null
data.values.*.source.pageverplichtinteger | null
data.values.*.source.sectionverplichtstring | null
data.values.*.source.excerptverplichtstring | null
data.values.*.previousverplichtobject | null
data.values.*.previous.valueverplichtnumber | null
data.values.*.previous.stateverplichtenum known · not_mentioned · not_known · not_reported
data.values.*.previous.report_numberverplichtinteger | null
data.values.*.previous.report_dateverplichtstring | null
data.values.*.deltaverplichtnumber | null
data.values.*.curatorverplichtobject | null
data.values.*.curator.valueverplichtnumber | null
data.values.*.curator.as_ofverplichtstring
data.topicsverplichtobject[]
data.topics[].topicverplichtstring
data.topics[].stateverplichtstring
data.topics[].report_numberverplichtinteger | null
data.topics[].report_dateverplichtstring | null
data.topics[].sourceverplichtobject | null
data.topics[].source.documentverplichtobject | null
data.topics[].source.document.idverplichtstring
data.topics[].source.document.titleverplichtstring | null
data.topics[].source.document.report_numberverplichtinteger | null
data.topics[].source.document.report_dateverplichtstring | null
data.topics[].source.document.published_onverplichtstring | null
data.topics[].source.document.page_countverplichtinteger | null
data.topics[].source.document.urlverplichtstring | null
data.topics[].source.document.sha256verplichtstring | null
data.topics[].source.pageverplichtinteger | null
data.topics[].source.sectionverplichtstring | null
data.topics[].source.excerptverplichtstring | null
data.reportsverplichtobject[]
data.reports[].idverplichtstring
data.reports[].numberverplichtinteger | null
data.reports[].titleverplichtstring
data.reports[].is_finalverplichtboolean
data.reports[].published_onverplichtstring
data.reports[].period_startverplichtstring | null
data.reports[].period_endverplichtstring | null
data.reports[].page_countverplichtinteger | null
data.reports[].document_urlverplichtstring | null
data.reports[].linksverplichtobject
data.reports[].links.selfverplichtstring
data.linksverplichtobject
data.links.selfverplichtstring
data.links.changesverplichtstring
data.links.webverplichtstring

Antwoord · HTTP 404

Not found

Antwoord · HTTP 404

Antwoord · HTTP 404
NaamTypeOmschrijving
errorverplichtobject
error.codeverplicht

Stable error code, for example not_found or validation_failed

stringStable error code, for example not_found or validation_failed
error.messageverplicht

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