{ "openapi": "3.0.1", "info": { "title": "German Insolvency Check — Bulk Name Screening", "description": "Check company or personal names against Germany's official insolvency register (insolvenzbekanntmachungen.de). One row per name checked — found or not — with the court, file number, register entry and the derived state of the proceeding. Built for bulk screening of customer lists.", "version": "0.1", "x-build-id": "Q4kXZg4FSeL9F2lkm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/us0r~insolvenz-check-de/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-us0r-insolvenz-check-de", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/us0r~insolvenz-check-de/runs": { "post": { "operationId": "runs-sync-us0r-insolvenz-check-de", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/us0r~insolvenz-check-de/run-sync": { "post": { "operationId": "run-sync-us0r-insolvenz-check-de", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "abfragen" ], "properties": { "abfragen": { "title": "Names to check", "type": "array", "description": "One entry per name. Either a plain string (\"Musterbau GmbH\") or an object with more detail: {\"name\": \"Schmidt\", \"vorname\": \"Peter\", \"ort\": \"München\", \"bundesland\": \"BY\"}. The extra fields narrow a common name and are what breaks the portal's 1,000-hit ceiling.", "default": [ "Pflegedienst HAVA GmbH", { "name": "Schmidt", "ort": "München" } ] }, "suchmodus": { "title": "Match mode", "enum": [ "enthaelt", "beginntMit", "exakt" ], "type": "string", "description": "How the name is matched. \"enthaelt\" wraps it in wildcards and is the safest for company names, which courts write with varying legal-form suffixes.", "default": "enthaelt" }, "statusErmitteln": { "title": "Derive the state of each proceeding", "type": "boolean", "description": "Reads the official text of the most recent announcement of each proceeding and derives whether it is still running. Costs one extra portal request per proceeding. Turn off for a pure hit/no-hit screening.", "default": true }, "maxVerfahrenJeAbfrage": { "title": "Proceedings to derive a state for, per name", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only the most recent N proceedings of a name get a state. All proceedings are returned either way.", "default": 10 }, "volltext": { "title": "Include the full official text", "type": "boolean", "description": "Fetches the complete announcement text for every hit and parses out administrator, deadlines and amounts. One extra request per announcement, billed separately.", "default": false }, "maxVolltexteJeAbfrage": { "title": "Full texts per name", "minimum": 0, "maximum": 500, "type": "integer", "description": "Upper bound so a common name cannot run up a bill.", "default": 20 }, "beiZuVielenTreffern": { "title": "When a name exceeds 1,000 hits", "enum": [ "aufteilen", "melden" ], "type": "string", "description": "The portal caps every result list at 1,000 hits. \"aufteilen\" repeats the query once per federal state (16 requests) and merges; \"melden\" simply flags the record.", "default": "aufteilen" }, "pauseSekunden": { "title": "Delay before each request (seconds)", "minimum": 0, "maximum": 10, "type": "number", "description": "Politeness delay towards the portal.", "default": 0.2 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }