{ "openapi": "3.0.1", "info": { "title": "France Company Risk Monitor — Insolvency & KYB Events (BODACC)", "description": "Daily feed of French company risk events from official BODACC open data — insolvency proceedings, strike-offs, business sales and modifications — enriched with NAF activity, officers, address and status. For KYB, credit-risk and portfolio monitoring.", "version": "0.1", "x-build-id": "xxdx63YyqXNZh9HDs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/akeeml~france-company-risk-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-akeeml-france-company-risk-monitor", "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/akeeml~france-company-risk-monitor/runs": { "post": { "operationId": "runs-sync-akeeml-france-company-risk-monitor", "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/akeeml~france-company-risk-monitor/run-sync": { "post": { "operationId": "run-sync-akeeml-france-company-risk-monitor", "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": { "eventFamilies": { "title": "Event types to monitor", "type": "array", "description": "Which BODACC event families to include. collective = insolvency proceedings, radiation = strike-off / dissolution, vente = business sale, modification = officer/capital/address change, creation = new registration, dpc = accounts filing.", "items": { "type": "string", "enum": [ "collective", "radiation", "vente", "modification", "creation", "dpc" ], "enumTitles": [ "Insolvency proceeding", "Strike-off / dissolution", "Business sale", "Modification", "New registration", "Accounts filing" ] }, "default": [ "collective", "radiation", "vente" ] }, "lastNDays": { "title": "Look-back window (days)", "minimum": 1, "maximum": 60, "type": "integer", "description": "Include notices published in the last N days. Ignored if 'Published since' is set. For a daily scheduled monitor, use 1–2.", "default": 7 }, "sinceDate": { "title": "Published since (YYYY-MM-DD)", "type": "string", "description": "Only notices published on/after this date. Overrides the look-back window. Use to page from your last run." }, "departments": { "title": "Departments", "type": "array", "description": "French department codes to include, e.g. 75, 92, 2A. Empty = all of France.", "items": { "type": "string" } }, "nafPrefixes": { "title": "NAF / APE sector prefixes", "type": "array", "description": "Keep only companies whose NAF activity code starts with one of these, e.g. 56 (food service), 41 (construction). Requires enrichment. Empty = all sectors.", "items": { "type": "string" } }, "enrich": { "title": "Enrich (NAF, officers, address, status)", "type": "boolean", "description": "Join each company to the official recherche-entreprises API to add NAF activity, officers, head-office address, employee band and administrative status (active/closed). Turn off for a faster bare notice feed.", "default": true }, "maxResults": { "title": "Max events", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of event rows to return per run.", "default": 200 } } }, "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 } } } } } } } } } }