{ "openapi": "3.0.1", "info": { "title": "BODACC Company Insolvency Check (France, by SIREN or Name)", "description": "Check whether a French company (by name or SIREN) has any insolvency proceedings on BODACC before you extend credit or sign a contract: court, judgment type and filing date. Can also monitor new filings on a schedule. Liquidator/officer and sole-trader debtor names are excluded", "version": "0.1", "x-build-id": "wdth7Ncwgvw9JEFcH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/chosen_loafer~france-insolvency-monitor-bodacc/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-chosen_loafer-france-insolvency-monitor-bodacc", "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/chosen_loafer~france-insolvency-monitor-bodacc/runs": { "post": { "operationId": "runs-sync-chosen_loafer-france-insolvency-monitor-bodacc", "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/chosen_loafer~france-insolvency-monitor-bodacc/run-sync": { "post": { "operationId": "run-sync-chosen_loafer-france-insolvency-monitor-bodacc", "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", "properties": { "companyName": { "title": "Company name", "type": "string", "description": "Filter by (part of) the registered company or trader name, e.g. \"Dupont\". Leave empty to monitor all new insolvency filings in the date window." }, "companyId": { "title": "Company registry ID (SIREN)", "type": "string", "description": "Filter by the French SIREN number (9 digits, spaces are ignored), e.g. \"488307372\"." }, "countries": { "title": "Countries", "type": "array", "description": "Countries to monitor. Only France (BODACC) ships in this version; DE, PL, IT, NL and ES were probed in recon and dropped for now, see NOTES.md.", "items": { "type": "string", "enum": [ "FR" ], "enumTitles": [ "France (BODACC)" ] }, "default": [ "FR" ] }, "dateFrom": { "title": "Date from", "type": "string", "description": "ISO date (YYYY-MM-DD). Only filings published on or after this date are returned. Defaults to 30 days ago." }, "dateTo": { "title": "Date to", "type": "string", "description": "ISO date (YYYY-MM-DD). Only filings published on or before this date are returned. Defaults to today." }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of insolvency records to output.", "default": 100 }, "maxChecked": { "title": "Max records checked", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Safety cap on how many candidate records are read from the source in this run (each is a billed event, whether or not it is complete enough to push). Stops the run even if \"Max results\" hasn't been reached yet, e.g. for a narrow filter with few matches in the date window.", "default": 300 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }