{ "openapi": "3.1.0", "info": { "title": "Faillissement.app API", "version": "1.0.0", "description": "Faillissement.app API: openbare Nederlandse insolventiegegevens met herkomst per gegeven. Authenticatie met een API-sleutel (Authorization: Bearer fa_live_\u2026) of een OAuth-token." }, "servers": [ { "url": "https:\/\/api.faillissement.app\/api\/v1" } ], "security": [ { "http": [] } ], "paths": { "\/auctions": { "get": { "operationId": "v1.auctions.index", "tags": [ "Auction" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "closing", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "today", "7d", "30d", null ] } }, { "name": "category[]", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AuctionCategory" } } }, { "name": "provider[]", "in": "query", "schema": { "type": "array", "items": { "type": "string", "maxLength": 120 } } }, { "name": "linked", "in": "query", "schema": { "type": [ "boolean", "null" ] } }, { "name": "sector", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", null ] } }, { "name": "curator", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 80 } }, { "name": "postcode", "in": "query", "schema": { "type": [ "string", "null" ], "pattern": "^\\d{4}\\s?[A-Za-z]{2}$" } }, { "name": "radius", "in": "query", "schema": { "type": [ "integer", "null" ], "enum": [ "10", "25", "50", "100", null ] } }, { "name": "sort", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "closing", "distance", "newest", null ] } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "__PHP_Incomplete_Class_Name": "stdClass" } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "page": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "total", "page", "last_page" ] } }, "required": [ "data", "meta" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "x-scope": "auctions:read", "x-credits": 1, "x-credits-per": "call" } }, "\/auctions\/{auction}": { "get": { "operationId": "v1.auctions.show", "tags": [ "Auction" ], "parameters": [ { "name": "auction", "in": "path", "required": true, "description": "Auction id (ULID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "matches": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "__PHP_Incomplete_Class_Name": "stdClass" } } }, "required": [ "matches", "sources" ], "additionalProperties": { "__PHP_Incomplete_Class_Name": "stdClass" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } }, "x-scope": "auctions:read", "x-credits": 1, "x-credits-per": "call" } }, "\/cases": { "get": { "operationId": "v1.cases.index", "tags": [ "Case" ], "parameters": [ { "name": "sort", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "relevance", "declared_desc", "declared_asc", "name", "estate_assets_desc", "creditor_count_desc", "distance", null ] } }, { "name": "mode", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "lexical", "semantic", null ] } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 400 } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } }, { "name": "q", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 200 } }, { "name": "q_scope", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "all", "name", "kvk", "curator", "location", null ] } }, { "name": "status[]", "in": "query", "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CaseStatus" } } }, { "name": "procedure[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "declared_from", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date" } }, { "name": "declared_to", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date" } }, { "name": "cir_publication_from", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date" } }, { "name": "cir_publication_to", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date" } }, { "name": "province[]", "in": "query", "schema": { "type": "array", "enum": [ "Groningen", "Frysl\u00e2n", "Drenthe", "Overijssel", "Flevoland", "Gelderland", "Utrecht", "Noord-Holland", "Zuid-Holland", "Zeeland", "Noord-Brabant", "Limburg" ], "items": { "type": "string", "enum": [ "Groningen", "Frysl\u00e2n", "Drenthe", "Overijssel", "Flevoland", "Gelderland", "Utrecht", "Noord-Holland", "Zuid-Holland", "Zeeland", "Noord-Brabant", "Limburg" ] } } }, { "name": "city", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 80 } }, { "name": "municipality", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 80 } }, { "name": "postcode", "in": "query", "schema": { "type": [ "string", "null" ], "pattern": "^[1-9][0-9]{3}\\s?[A-Za-z]{2}$" } }, { "name": "radius", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } }, { "name": "bbox", "in": "query", "schema": { "type": [ "string", "null" ], "pattern": "^-?\\d{1,3}(\\.\\d+)?(,-?\\d{1,3}(\\.\\d+)?){3}$" } }, { "name": "court[]", "in": "query", "schema": { "type": "array", "items": { "type": "string", "maxLength": 220 } } }, { "name": "curator[]", "in": "query", "schema": { "type": "array", "items": { "type": "string", "maxLength": 220 } } }, { "name": "law_firm[]", "in": "query", "schema": { "type": "array", "items": { "type": "string", "maxLength": 220 } } }, { "name": "legal_form[]", "in": "query", "schema": { "type": "array", "items": { "type": "string", "maxLength": 60 } } }, { "name": "sbi[]", "in": "query", "schema": { "type": "array", "pattern": "^[A-U]$", "items": { "type": "string", "pattern": "^[A-U]$" } } }, { "name": "has_report", "in": "query", "schema": { "type": [ "boolean", "null" ] } }, { "name": "topic[]", "in": "query", "schema": { "type": "array", "pattern": "^(going_concern|asset_sales|receivables_collection|employees|security_rights|lease_contracts|legality_review|director_liability|bookkeeping_duty|annual_accounts_filing|causes_investigation|paulianas|related_party_transactions|fraud_report|proceedings)(:(not_mentioned|mentioned|announced|investigating|ongoing|completed|not_applicable))?$", "items": { "type": "string", "pattern": "^(going_concern|asset_sales|receivables_collection|employees|security_rights|lease_contracts|legality_review|director_liability|bookkeeping_duty|annual_accounts_filing|causes_investigation|paulianas|related_party_transactions|fraud_report|proceedings)(:(not_mentioned|mentioned|announced|investigating|ongoing|completed|not_applicable))?$" } } }, { "name": "estate_assets_min", "in": "query", "schema": { "type": [ "number", "null" ], "minimum": 0, "maximum": 9999999999999 } }, { "name": "estate_assets_max", "in": "query", "schema": { "type": [ "number", "null" ], "minimum": 0, "maximum": 9999999999999 } }, { "name": "concurrent_claims_min", "in": "query", "schema": { "type": [ "number", "null" ], "minimum": 0, "maximum": 9999999999999 } }, { "name": "concurrent_claims_max", "in": "query", "schema": { "type": [ "number", "null" ], "minimum": 0, "maximum": 9999999999999 } }, { "name": "creditor_count_min", "in": "query", "schema": { "type": [ "number", "null" ], "minimum": 0, "maximum": 9999999999999 } }, { "name": "creditor_count_max", "in": "query", "schema": { "type": [ "number", "null" ], "minimum": 0, "maximum": 9999999999999 } }, { "name": "employee_count_min", "in": "query", "schema": { "type": [ "number", "null" ], "minimum": 0, "maximum": 9999999999999 } }, { "name": "employee_count_max", "in": "query", "schema": { "type": [ "number", "null" ], "minimum": 0, "maximum": 9999999999999 } }, { "name": "conditions", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 6000 } } ], "responses": { "200": { "description": "Public data", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "procedure": { "type": "string" }, "insolvency_number": { "type": "string" }, "declared_on": { "type": "string" }, "last_cir_publication_on": { "type": [ "string", "null" ] }, "terminated_on": { "type": [ "string", "null" ] }, "legal_form": { "type": [ "string", "null" ] }, "sbi_code": { "type": [ "string", "null" ] }, "sbi_section": { "type": [ "string", "null" ] }, "last_report_on": { "type": [ "string", "null" ] }, "court": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] } }, "required": [ "name", "slug" ] }, "location": { "type": "object", "properties": { "city": { "type": [ "string", "null" ] }, "municipality": { "type": [ "string", "null" ] }, "province": { "type": [ "string", "null" ] }, "lat": { "type": [ "number", "null" ] }, "lng": { "type": [ "number", "null" ] } }, "required": [ "city", "municipality", "province", "lat", "lng" ] }, "curator": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "slug": { "type": [ "string", "null" ] } }, "required": [ "name", "slug" ] }, "figures": { "type": "object", "properties": { "estate_assets": { "type": [ "number", "null" ] }, "concurrent_claims": { "type": [ "number", "null" ] }, "creditor_count": { "type": [ "integer", "null" ] }, "employee_count": { "type": [ "integer", "null" ] } }, "required": [ "estate_assets", "concurrent_claims", "creditor_count", "employee_count" ] }, "report_count": { "type": "integer" }, "topics": { "type": "array", "items": { "type": "object", "properties": { "topic": { "type": "string" }, "state": { "type": "string" } }, "required": [ "topic", "state" ] } }, "links": { "type": "object", "properties": { "self": { "type": "string" }, "web": { "type": "string" } }, "required": [ "self", "web" ] } }, "required": [ "id", "slug", "name", "status", "procedure", "insolvency_number", "declared_on", "last_cir_publication_on", "terminated_on", "legal_form", "sbi_code", "sbi_section", "last_report_on", "court", "location", "curator", "figures", "report_count", "topics", "links" ] } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "total", "page", "per_page", "last_page" ] } }, "required": [ "data", "meta" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "x-scope": "cases:read", "x-credits": 1, "x-credits-per": "call" } }, "\/cases\/{case}": { "get": { "operationId": "v1.cases.show", "tags": [ "Case" ], "parameters": [ { "name": "case", "in": "path", "required": true, "description": "Case id (ULID) or the case slug", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public data", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "procedure": { "type": "string" }, "insolvency_number": { "type": "string" }, "case_number": { "type": "string" }, "declared_on": { "type": "string" }, "terminated_on": { "type": [ "string", "null" ] }, "termination_reason": { "type": [ "string", "null" ] }, "kvk_number": { "type": [ "string", "null" ] }, "judge": { "type": [ "string", "null" ] }, "last_report_on": { "type": [ "string", "null" ] }, "last_update_at": { "type": [ "string", "null" ] }, "trade_names": { "type": "array", "items": { "type": "string" } }, "procedure_type": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "family": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "short_name": { "type": [ "string", "null" ] }, "legal_basis": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "provision": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "provision", "url" ] }, "features": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "key", "family", "name", "short_name", "legal_basis", "features" ] }, "legal_form": { "type": [ "object", "null" ], "properties": { "value": { "type": "string" } }, "required": [ "value" ] }, "sbi": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "version": { "type": [ "string", "null" ] } }, "required": [ "code", "description", "version" ] }, "court": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" }, "location": { "type": [ "string", "null" ] } }, "required": [ "name", "slug", "location" ] }, "curator": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "slug": { "type": "string" }, "law_firm": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "verified": { "type": "boolean" } }, "required": [ "name", "slug", "law_firm", "city", "verified" ] }, "location": { "type": [ "object", "null" ], "properties": { "street": { "type": [ "string", "null" ] }, "house_number": { "type": [ "string", "null" ] }, "addition": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "municipality": { "type": [ "string", "null" ] }, "province": { "type": [ "string", "null" ] }, "kind": { "type": [ "string", "null" ] }, "lat": { "type": [ "number", "null" ] }, "lng": { "type": [ "number", "null" ] } }, "required": [ "street", "house_number", "addition", "postal_code", "city", "municipality", "province", "kind", "lat", "lng" ] }, "counts": { "type": "object", "properties": { "reports": { "type": "integer" }, "documents": { "type": "integer" }, "assets": { "type": "integer" }, "investigations": { "type": "integer" }, "news": { "type": "integer" } }, "required": [ "reports", "documents", "assets", "investigations", "news" ] }, "report_count": { "type": "integer" }, "linked": { "type": "object", "properties": { "continued_from": { "type": [ "object", "null" ], "properties": { "slug": { "type": "string" }, "case_number": { "type": [ "string", "null" ] }, "procedure": { "type": "string" }, "court": { "type": [ "string", "null" ] }, "relation": { "type": [ "string", "null" ] } }, "required": [ "slug", "case_number", "procedure", "court", "relation" ] }, "continued_as": { "type": [ "object", "null" ], "properties": { "slug": { "type": "string" }, "case_number": { "type": [ "string", "null" ] }, "procedure": { "type": "string" }, "court": { "type": [ "string", "null" ] }, "relation": { "type": [ "string", "null" ] } }, "required": [ "slug", "case_number", "procedure", "court", "relation" ] } }, "required": [ "continued_from", "continued_as" ] }, "values": { "type": "object", "additionalProperties": { "type": "object", "properties": { "field": { "type": "string" }, "kind": { "type": "string" }, "value": { "type": [ "number", "null" ] }, "state": { "type": "string", "enum": [ "known", "not_mentioned", "not_known", "not_reported" ] }, "qualifier": { "type": [ "string", "null" ] }, "as_of": { "type": [ "string", "null" ] }, "report_number": { "type": [ "integer", "null" ] }, "report_date": { "type": [ "string", "null" ] }, "source": { "type": [ "object", "null" ], "properties": { "document": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "report_number": { "type": [ "integer", "null" ] }, "report_date": { "type": [ "string", "null" ] }, "published_on": { "type": [ "string", "null" ] }, "page_count": { "type": [ "integer", "null" ] }, "url": { "type": [ "string", "null" ] }, "sha256": { "type": [ "string", "null" ] } }, "required": [ "id", "title", "report_number", "report_date", "published_on", "page_count", "url", "sha256" ] }, "page": { "type": [ "integer", "null" ] }, "section": { "type": [ "string", "null" ] }, "excerpt": { "type": [ "string", "null" ] } }, "required": [ "document", "page", "section", "excerpt" ] }, "previous": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "number", "null" ] }, "state": { "type": "string", "enum": [ "known", "not_mentioned", "not_known", "not_reported" ] }, "report_number": { "type": [ "integer", "null" ] }, "report_date": { "type": [ "string", "null" ] } }, "required": [ "value", "state", "report_number", "report_date" ] }, "delta": { "type": [ "number", "null" ] }, "curator": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "number", "null" ] }, "as_of": { "type": "string" } }, "required": [ "value", "as_of" ] } }, "required": [ "field", "kind", "value", "state", "qualifier", "as_of", "report_number", "report_date", "source", "previous", "delta", "curator" ] } }, "topics": { "type": "array", "items": { "type": "object", "properties": { "topic": { "type": "string" }, "state": { "type": "string" }, "report_number": { "type": [ "integer", "null" ] }, "report_date": { "type": [ "string", "null" ] }, "source": { "type": [ "object", "null" ], "properties": { "document": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "report_number": { "type": [ "integer", "null" ] }, "report_date": { "type": [ "string", "null" ] }, "published_on": { "type": [ "string", "null" ] }, "page_count": { "type": [ "integer", "null" ] }, "url": { "type": [ "string", "null" ] }, "sha256": { "type": [ "string", "null" ] } }, "required": [ "id", "title", "report_number", "report_date", "published_on", "page_count", "url", "sha256" ] }, "page": { "type": [ "integer", "null" ] }, "section": { "type": [ "string", "null" ] }, "excerpt": { "type": [ "string", "null" ] } }, "required": [ "document", "page", "section", "excerpt" ] } }, "required": [ "topic", "state", "report_number", "report_date", "source" ] } }, "reports": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "number": { "type": [ "integer", "null" ] }, "title": { "type": "string" }, "is_final": { "type": "boolean" }, "published_on": { "type": "string" }, "period_start": { "type": [ "string", "null" ] }, "period_end": { "type": [ "string", "null" ] }, "page_count": { "type": [ "integer", "null" ] }, "document_url": { "type": [ "string", "null" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] } }, "required": [ "id", "number", "title", "is_final", "published_on", "period_start", "period_end", "page_count", "document_url", "links" ] } }, "links": { "type": "object", "properties": { "self": { "type": "string" }, "changes": { "type": "string" }, "web": { "type": "string" } }, "required": [ "self", "changes", "web" ] } }, "required": [ "id", "slug", "name", "status", "procedure", "insolvency_number", "case_number", "declared_on", "terminated_on", "termination_reason", "kvk_number", "judge", "last_report_on", "last_update_at", "trade_names", "procedure_type", "legal_form", "sbi", "court", "curator", "location", "counts", "report_count", "linked", "values", "topics", "reports", "links" ] } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } }, "x-scope": "cases:read", "x-credits": 1, "x-credits-per": "call" } }, "\/cases\/{case}\/changes": { "get": { "operationId": "v1.cases.changes", "tags": [ "Change" ], "parameters": [ { "name": "case", "in": "path", "required": true, "description": "Case id (ULID) or the case slug", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 26, "maxLength": 26 } }, { "name": "to", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 26, "maxLength": 26 } }, { "name": "since", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date" } } ], "responses": { "200": { "description": "Public data", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": [ "object", "null" ], "properties": { "from": { "type": "object", "properties": { "id": { "type": "string" }, "number": { "type": [ "integer", "null" ] }, "title": { "type": "string" }, "published_on": { "type": "string" }, "document_url": { "type": [ "string", "null" ] } }, "required": [ "id", "number", "title", "published_on", "document_url" ] }, "to": { "type": "object", "properties": { "id": { "type": "string" }, "number": { "type": [ "integer", "null" ] }, "title": { "type": "string" }, "published_on": { "type": "string" }, "document_url": { "type": [ "string", "null" ] } }, "required": [ "id", "number", "title", "published_on", "document_url" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "kind": { "type": "string" }, "change": { "type": "string" }, "from": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "number", "null" ] }, "state": { "type": "string", "enum": [ "known", "not_mentioned", "not_known", "not_reported" ] }, "qualifier": { "type": [ "string", "null" ] } }, "required": [ "value", "state", "qualifier" ] }, "to": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "number", "null" ] }, "state": { "type": "string", "enum": [ "known", "not_mentioned", "not_known", "not_reported" ] }, "qualifier": { "type": [ "string", "null" ] } }, "required": [ "value", "state", "qualifier" ] }, "delta": { "type": [ "number", "null" ] }, "from_source": { "type": [ "object", "null" ], "properties": { "document": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "report_number": { "type": [ "integer", "null" ] }, "report_date": { "type": [ "string", "null" ] }, "published_on": { "type": [ "string", "null" ] }, "page_count": { "type": [ "integer", "null" ] }, "url": { "type": [ "string", "null" ] }, "sha256": { "type": [ "string", "null" ] } }, "required": [ "id", "title", "report_number", "report_date", "published_on", "page_count", "url", "sha256" ] }, "page": { "type": [ "integer", "null" ] }, "section": { "type": [ "string", "null" ] }, "excerpt": { "type": [ "string", "null" ] } }, "required": [ "document", "page", "section", "excerpt" ] }, "to_source": { "type": [ "object", "null" ], "properties": { "document": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "report_number": { "type": [ "integer", "null" ] }, "report_date": { "type": [ "string", "null" ] }, "published_on": { "type": [ "string", "null" ] }, "page_count": { "type": [ "integer", "null" ] }, "url": { "type": [ "string", "null" ] }, "sha256": { "type": [ "string", "null" ] } }, "required": [ "id", "title", "report_number", "report_date", "published_on", "page_count", "url", "sha256" ] }, "page": { "type": [ "integer", "null" ] }, "section": { "type": [ "string", "null" ] }, "excerpt": { "type": [ "string", "null" ] } }, "required": [ "document", "page", "section", "excerpt" ] } }, "required": [ "field", "kind", "change", "from", "to", "delta", "from_source", "to_source" ] } }, "topics": { "type": "array", "items": { "type": "object", "properties": { "topic": { "type": "string" }, "change": { "type": "string" }, "from": { "type": [ "string", "null" ] }, "to": { "type": [ "string", "null" ] }, "investigation": { "type": "boolean" }, "to_source": { "type": [ "object", "null" ], "properties": { "document": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "report_number": { "type": [ "integer", "null" ] }, "report_date": { "type": [ "string", "null" ] }, "published_on": { "type": [ "string", "null" ] }, "page_count": { "type": [ "integer", "null" ] }, "url": { "type": [ "string", "null" ] }, "sha256": { "type": [ "string", "null" ] } }, "required": [ "id", "title", "report_number", "report_date", "published_on", "page_count", "url", "sha256" ] }, "page": { "type": [ "integer", "null" ] }, "section": { "type": [ "string", "null" ] }, "excerpt": { "type": [ "string", "null" ] } }, "required": [ "document", "page", "section", "excerpt" ] } }, "required": [ "topic", "change", "from", "to", "investigation", "to_source" ] } }, "summary": { "type": "object", "additionalProperties": { "type": "integer" } } }, "required": [ "from", "to", "values", "topics", "summary" ] }, "meta": { "type": "object", "properties": { "reports": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "number": { "type": [ "integer", "null" ] }, "title": { "type": "string" }, "published_on": { "type": "string" }, "document_url": { "type": [ "string", "null" ] } }, "required": [ "id", "number", "title", "published_on", "document_url" ] } } }, "required": [ "reports" ] } }, "required": [ "data", "meta" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } }, "x-scope": "cases:read", "x-credits": 3, "x-credits-per": "call" } }, "\/day": { "get": { "operationId": "v1.day", "tags": [ "Day" ], "parameters": [ { "name": "date", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date" } } ], "responses": { "200": { "description": "Public data", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "counts": { "type": "object", "properties": { "declared": { "type": "integer" }, "changes": { "type": "integer" }, "terminated": { "type": "integer" }, "reports": { "type": "integer" } }, "required": [ "declared", "changes", "terminated", "reports" ] }, "declared": { "type": "array", "items": { "type": "object", "properties": { "procedure": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "procedure": { "type": "string" }, "insolvency_number": { "type": "string" }, "declared_on": { "type": "string" }, "last_cir_publication_on": { "type": [ "string", "null" ] }, "terminated_on": { "type": [ "string", "null" ] }, "legal_form": { "type": [ "string", "null" ] }, "sbi_code": { "type": [ "string", "null" ] }, "sbi_section": { "type": [ "string", "null" ] }, "last_report_on": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "court": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] } }, "required": [ "name", "slug" ] }, "location": { "type": "object", "properties": { "city": { "type": [ "string", "null" ] }, "municipality": { "type": [ "string", "null" ] }, "province": { "type": [ "string", "null" ] }, "lat": { "type": [ "number", "null" ] }, "lng": { "type": [ "number", "null" ] } }, "required": [ "city", "municipality", "province", "lat", "lng" ] }, "curator": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "slug": { "type": [ "string", "null" ] } }, "required": [ "name", "slug" ] }, "figures": { "type": "object", "properties": { "estate_assets": { "type": [ "number", "null" ] }, "concurrent_claims": { "type": [ "number", "null" ] }, "creditor_count": { "type": [ "integer", "null" ] }, "employee_count": { "type": [ "integer", "null" ] } }, "required": [ "estate_assets", "concurrent_claims", "creditor_count", "employee_count" ] }, "report_count": { "type": "integer" }, "distance_km": { "type": [ "number", "null" ] }, "topics": { "type": "array", "items": { "type": "object", "properties": { "topic": { "type": "string" }, "state": { "type": "string" } }, "required": [ "topic", "state" ] } } }, "required": [ "id", "slug", "name", "status", "procedure", "insolvency_number", "declared_on", "last_cir_publication_on", "terminated_on", "legal_form", "sbi_code", "sbi_section", "last_report_on", "summary", "court", "location", "curator", "figures", "report_count", "distance_km", "topics" ] } } }, "required": [ "procedure", "name", "total", "items" ] } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "payload": { "type": "object", "properties": { "report_id": { "__PHP_Incomplete_Class_Name": "stdClass" }, "report_number": { "__PHP_Incomplete_Class_Name": "stdClass" }, "report_date": { "__PHP_Incomplete_Class_Name": "stdClass" }, "title": { "__PHP_Incomplete_Class_Name": "stdClass" }, "description": { "__PHP_Incomplete_Class_Name": "stdClass" }, "type": { "__PHP_Incomplete_Class_Name": "stdClass" }, "curator": { "__PHP_Incomplete_Class_Name": "stdClass" }, "role": { "__PHP_Incomplete_Class_Name": "stdClass" }, "status": { "__PHP_Incomplete_Class_Name": "stdClass" }, "from": { "__PHP_Incomplete_Class_Name": "stdClass" }, "to": { "__PHP_Incomplete_Class_Name": "stdClass" }, "reason": { "__PHP_Incomplete_Class_Name": "stdClass" }, "provider": { "__PHP_Incomplete_Class_Name": "stdClass" }, "publication_id": { "__PHP_Incomplete_Class_Name": "stdClass" }, "date_basis": { "__PHP_Incomplete_Class_Name": "stdClass" }, "is_final": { "__PHP_Incomplete_Class_Name": "stdClass" } } }, "case": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "court": { "type": [ "string", "null" ] }, "declared_on": { "type": [ "string", "null" ] }, "status": { "type": "string" } }, "required": [ "id", "slug", "name", "court", "declared_on", "status" ] } }, "required": [ "id", "type", "payload", "case" ] } }, "reports": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "number": { "type": [ "integer", "null" ] }, "published_on": { "type": "string" }, "is_final": { "type": "boolean" }, "changes": { "type": [ "integer", "null" ] }, "case": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "slug", "name" ] } }, "required": [ "id", "number", "published_on", "is_final", "changes", "case" ] } } }, "required": [ "date", "counts", "declared", "changes", "reports" ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "x-scope": "day:read", "x-credits": 1, "x-credits-per": "call" } }, "\/cases\/{case}\/fields\/{field}\/history": { "get": { "operationId": "v1.cases.history", "tags": [ "FieldHistory" ], "parameters": [ { "name": "case", "in": "path", "required": true, "description": "Case id (ULID) or the case slug", "schema": { "type": "string" } }, { "name": "field", "in": "path", "required": true, "description": "Field name, for example estate_assets", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public data", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": [ "number", "null" ] }, "state": { "type": "string", "enum": [ "known", "not_mentioned", "not_known", "not_reported" ] }, "qualifier": { "type": [ "string", "null" ] }, "as_of": { "type": "string" }, "report_number": { "type": [ "integer", "null" ] }, "report_date": { "type": [ "string", "null" ] }, "current": { "type": "boolean" }, "sources": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "document": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "report_number": { "type": [ "integer", "null" ] }, "report_date": { "type": [ "string", "null" ] }, "published_on": { "type": [ "string", "null" ] }, "page_count": { "type": [ "integer", "null" ] }, "url": { "type": [ "string", "null" ] }, "sha256": { "type": [ "string", "null" ] } }, "required": [ "id", "title", "report_number", "report_date", "published_on", "page_count", "url", "sha256" ] }, "page": { "type": [ "integer", "null" ] }, "section": { "type": [ "string", "null" ] }, "excerpt": { "type": [ "string", "null" ] } }, "required": [ "document", "page", "section", "excerpt" ] } } }, "required": [ "id", "value", "state", "qualifier", "as_of", "report_number", "report_date", "current", "sources" ] } }, "meta": { "type": "object", "properties": { "field": { "type": "string" }, "kind": { "type": "string" }, "total": { "type": "integer" } }, "required": [ "field", "kind", "total" ] } }, "required": [ "data", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } }, "x-scope": "history:read", "x-credits": 2, "x-credits-per": "call" } }, "\/portfolio\/match": { "post": { "operationId": "v1.portfolio.match", "tags": [ "Match" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PortfolioMatchRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "kvk_number": { "type": "string" }, "matched": { "type": "string" }, "cases": { "type": "string" } }, "required": [ "kvk_number", "matched", "cases" ] } }, "meta": { "type": "object", "properties": { "numbers": { "type": "integer" }, "matched": { "type": "integer", "minimum": 0 }, "credits": { "type": "number" } }, "required": [ "numbers", "matched", "credits" ] } }, "required": [ "data", "meta" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "x-scope": "portfolio:match", "x-credits": 0.1, "x-credits-per": "kvk_number" } }, "\/news": { "get": { "operationId": "v1.news", "tags": [ "News" ], "parameters": [ { "name": "case", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 26, "maxLength": 26 } }, { "name": "since", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date" } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "case": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] } }, "required": [ "id", "name", "links" ] } }, "required": [ "case" ], "additionalProperties": { "__PHP_Incomplete_Class_Name": "stdClass" } } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "total", "page", "per_page", "last_page" ] } }, "required": [ "data", "meta" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "x-scope": "news:read", "x-credits": 1, "x-credits-per": "call" } }, "\/procedure-types": { "get": { "operationId": "v1.procedure-types", "tags": [ "ProcedureType" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "family": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "short_name": { "type": [ "string", "null" ] }, "legal_basis": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "provision": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "provision", "url" ] }, "features": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "key", "family", "name", "short_name", "legal_basis", "features" ] } } }, "required": [ "data" ] } } } } }, "x-scope": "cases:read", "x-credits": null, "x-credits-per": "call" } }, "\/reports\/{report}": { "get": { "operationId": "v1.reports.show", "tags": [ "Report" ], "parameters": [ { "name": "report", "in": "path", "required": true, "description": "Report id (ULID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public data", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "number": { "type": [ "integer", "null" ] }, "title": { "type": "string" }, "is_final": { "type": "boolean" }, "published_on": { "type": "string" }, "period_start": { "type": [ "string", "null" ] }, "period_end": { "type": [ "string", "null" ] }, "page_count": { "type": [ "integer", "null" ] }, "document_url": { "type": [ "string", "null" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "case": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] } }, "required": [ "id", "name", "links" ] }, "sha256": { "type": [ "string", "null" ] }, "sections": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "heading": { "type": "string" }, "page_from": { "type": "integer" }, "page_to": { "type": "integer" } }, "required": [ "code", "heading", "page_from", "page_to" ] } }, "values": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "kind": { "type": "string", "enum": [ "count", "hours", "decimal", "amount" ] }, "value": { "type": [ "number", "null" ] }, "state": { "type": "string" }, "qualifier": { "type": [ "string", "null" ] }, "as_of": { "type": "string" }, "source": { "type": [ "object", "null" ], "properties": { "document": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "report_number": { "type": [ "integer", "null" ] }, "report_date": { "type": [ "string", "null" ] }, "published_on": { "type": [ "string", "null" ] }, "page_count": { "type": [ "integer", "null" ] }, "url": { "type": [ "string", "null" ] }, "sha256": { "type": [ "string", "null" ] } }, "required": [ "id", "title", "report_number", "report_date", "published_on", "page_count", "url", "sha256" ] }, "page": { "type": [ "integer", "null" ] }, "section": { "type": [ "string", "null" ] }, "excerpt": { "type": [ "string", "null" ] } }, "required": [ "document", "page", "section", "excerpt" ] } }, "required": [ "field", "kind", "value", "state", "qualifier", "as_of", "source" ] } }, "topics": { "type": "array", "items": { "type": "object", "properties": { "topic": { "type": "string" }, "state": { "type": "string" }, "source": { "type": [ "object", "null" ], "properties": { "document": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "report_number": { "type": [ "integer", "null" ] }, "report_date": { "type": [ "string", "null" ] }, "published_on": { "type": [ "string", "null" ] }, "page_count": { "type": [ "integer", "null" ] }, "url": { "type": [ "string", "null" ] }, "sha256": { "type": [ "string", "null" ] } }, "required": [ "id", "title", "report_number", "report_date", "published_on", "page_count", "url", "sha256" ] }, "page": { "type": [ "integer", "null" ] }, "section": { "type": [ "string", "null" ] }, "excerpt": { "type": [ "string", "null" ] } }, "required": [ "document", "page", "section", "excerpt" ] } }, "required": [ "topic", "state", "source" ] } } }, "required": [ "id", "number", "title", "is_final", "published_on", "period_start", "period_end", "page_count", "document_url", "links", "case", "sha256", "sections", "values", "topics" ] } }, "required": [ "data" ] } } } } }, "x-scope": "reports:read", "x-credits": 1, "x-credits-per": "call" } }, "\/reports\/{report}\/text": { "get": { "operationId": "v1.reports.text", "summary": "The extracted text per page, for reports whose text is available", "tags": [ "Report" ], "parameters": [ { "name": "report", "in": "path", "required": true, "description": "Report id (ULID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "language": { "type": "string" }, "sha256": { "type": [ "string", "null" ] }, "pages": { "type": "array", "items": { "type": "object", "properties": { "page": { "type": "integer" }, "text": { "type": "string" } }, "required": [ "page", "text" ] } } }, "required": [ "id", "language", "sha256", "pages" ] } }, "required": [ "data" ] } } } } }, "x-scope": "reports:text", "x-credits": 5, "x-credits-per": "call" } }, "\/cases\/{case}\/timeline": { "get": { "operationId": "v1.cases.timeline", "description": "Public events, newest first, with their factual details.", "summary": "Timeline of a case", "tags": [ "Timeline" ], "parameters": [ { "name": "case", "in": "path", "required": true, "description": "Case id (ULID) or the case slug", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Public data", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "occurred_at": { "type": [ "string", "null" ] }, "from_case": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "case_number": { "type": "string" } }, "required": [ "id", "case_number" ] }, "details": { "type": "object", "properties": { "report_id": { "__PHP_Incomplete_Class_Name": "stdClass" }, "report_number": { "__PHP_Incomplete_Class_Name": "stdClass" }, "report_date": { "__PHP_Incomplete_Class_Name": "stdClass" }, "title": { "__PHP_Incomplete_Class_Name": "stdClass" }, "description": { "__PHP_Incomplete_Class_Name": "stdClass" }, "type": { "__PHP_Incomplete_Class_Name": "stdClass" }, "curator": { "__PHP_Incomplete_Class_Name": "stdClass" }, "role": { "__PHP_Incomplete_Class_Name": "stdClass" }, "status": { "__PHP_Incomplete_Class_Name": "stdClass" }, "from": { "__PHP_Incomplete_Class_Name": "stdClass" }, "to": { "__PHP_Incomplete_Class_Name": "stdClass" }, "reason": { "__PHP_Incomplete_Class_Name": "stdClass" }, "provider": { "__PHP_Incomplete_Class_Name": "stdClass" }, "publication_id": { "__PHP_Incomplete_Class_Name": "stdClass" }, "date_basis": { "__PHP_Incomplete_Class_Name": "stdClass" }, "is_final": { "__PHP_Incomplete_Class_Name": "stdClass" } } } }, "required": [ "id", "type", "occurred_at", "from_case", "details" ] } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "page": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "total", "page", "last_page" ] } }, "required": [ "data", "meta" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } }, "x-scope": "cases:read", "x-credits": 1, "x-credits-per": "call" } }, "\/cases\/{case}\/documents": { "get": { "operationId": "v1.cases.documents", "description": "Public reports and register publications, newest first, with a link to the original.", "summary": "Documents of a case", "tags": [ "Timeline" ], "parameters": [ { "name": "case", "in": "path", "required": true, "description": "Case id (ULID) or the case slug", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public data", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "report", "publication" ] }, "id": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "report_number": { "type": [ "integer", "null" ] }, "publication_number": { "type": [ "integer", "null" ] }, "publication_type": { "type": "string" }, "date": { "type": "string", "format": "date" }, "pages": { "type": [ "integer", "null" ] }, "source": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "kind", "id", "title", "date", "source", "url" ] } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } }, "x-scope": "cases:read", "x-credits": 1, "x-credits-per": "call" } }, "\/webhooks": { "get": { "operationId": "v1.webhooks.index", "tags": [ "Webhook" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "__PHP_Incomplete_Class_Name": "stdClass" } } }, "required": [ "data" ] } } } } }, "x-scope": "webhooks:manage", "x-credits": 0, "x-credits-per": "call" }, "post": { "operationId": "v1.webhooks.store", "tags": [ "Webhook" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreWebhookRequest" } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "secret": { "type": "string" } }, "required": [ "secret" ], "additionalProperties": { "__PHP_Incomplete_Class_Name": "stdClass" } } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "x-scope": "webhooks:manage", "x-credits": 0, "x-credits-per": "call" } }, "\/webhooks\/{webhook}": { "delete": { "operationId": "v1.webhooks.destroy", "tags": [ "Webhook" ], "parameters": [ { "name": "webhook", "in": "path", "required": true, "description": "Webhook id (ULID)", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" } }, "x-scope": "webhooks:manage", "x-credits": 0, "x-credits-per": "call" } } }, "components": { "securitySchemes": { "http": { "type": "http", "scheme": "bearer" } }, "schemas": { "AuctionCategory": { "type": "string", "description": "Our own grouping of auctions; provider categories are mapped onto it.\n", "enum": [ "construction_machinery", "vehicles", "tools", "stock", "office_it", "hospitality", "real_estate", "other" ], "title": "AuctionCategory" }, "CaseField": { "type": "string", "description": "Structured values tracked per case over time. Each value is stored per report or curator update, so the history of a field stays reconstructable.\n", "enum": [ "estate_assets", "total_receipts", "estate_claims", "preferential_claims", "concurrent_claims", "secured_claims", "estate_account_balance", "curator_fee", "hours_spent", "payout_percentage", "creditor_count", "secured_creditor_count", "employee_count", "revenue_last_year" ], "title": "CaseField" }, "CaseStatus": { "type": "string", "description": "Current state of an insolvency case.\n", "enum": [ "active", "terminated", "converted", "annulled" ], "title": "CaseStatus" }, "PortfolioMatchRequest": { "type": "object", "properties": { "kvk_numbers": { "type": "array", "items": { "type": "string", "pattern": "^\\d{8}$" }, "minItems": 1 } }, "required": [ "kvk_numbers" ], "title": "PortfolioMatchRequest" }, "StoreWebhookRequest": { "type": "object", "description": "A webhook: an https URL and the events it receives. Whether the host is\npublic is checked when it is saved and again at every delivery.", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2000 }, "events": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebhookEvent" }, "minItems": 1, "uniqueItems": true }, "enabled": { "type": "boolean" } }, "required": [ "url", "events" ], "title": "StoreWebhookRequest" }, "ValueState": { "type": "string", "description": "Whether a value is known; unknown is never shown as zero or \"none\".\n", "enum": [ "known", "not_mentioned", "not_known", "not_reported" ], "title": "ValueState" }, "WebhookEvent": { "type": "string", "description": "Webhook events; the names are part of the public contract.\n", "enum": [ "case.created", "case.status_changed", "report.published", "report.processed", "value.corrected", "value.conflict", "portfolio.hit", "auction.linked" ], "title": "WebhookEvent" } }, "responses": { "ValidationException": { "description": "Validation error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable error code, for example not_found or validation_failed" }, "message": { "type": "string", "description": "Human-readable explanation" }, "details": { "type": "object", "description": "Extra information, such as the fields that failed validation" } }, "required": [ "code", "message" ] } }, "required": [ "error" ] } } } }, "ModelNotFoundException": { "description": "Not found", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable error code, for example not_found or validation_failed" }, "message": { "type": "string", "description": "Human-readable explanation" }, "details": { "type": "object", "description": "Extra information, such as the fields that failed validation" } }, "required": [ "code", "message" ] } }, "required": [ "error" ] } } } } } } }