{ "openapi": "3.0.1", "info": { "title": "French Companies Enricher — SIREN/SIRET lookup", "description": "Enrich French companies from the official open-data registry (recherche-entreprises.api.gouv.fr): SIREN/SIRET lookup, KYC status, NAF activity, address, leaders and financials. Pay per enriched company.", "version": "0.0", "x-build-id": "dg3te2U7h9kI370Pr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mjeason~french-company-enrichment/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mjeason-french-company-enrichment", "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/mjeason~french-company-enrichment/runs": { "post": { "operationId": "runs-sync-mjeason-french-company-enrichment", "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/mjeason~french-company-enrichment/run-sync": { "post": { "operationId": "run-sync-mjeason-french-company-enrichment", "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": [ "queries" ], "properties": { "queries": { "title": "Company queries (names or SIREN)", "minItems": 1, "type": "array", "description": "One entry per company or list you want to enrich. Each entry can be a company name (e.g. \"Danone\" or \"boulangerie Lyon\"), an exact 9-digit SIREN (e.g. \"552100554\"), or a SIRET (the first 9 digits are used by the registry). Every company is emitted once, even if it matches several queries — you are not billed twice for it.", "items": { "type": "string", "minLength": 3 } }, "maxResultsPerQuery": { "title": "Maximum companies per query", "minimum": 1, "maximum": 500, "type": "integer", "description": "Upper bound of companies kept for each query. A SIREN query returns a single company; name searches can match hundreds of companies, so this number is also your cost cap: each returned company costs one billing event. The registry API pages 25 records at a time, so values above 25 trigger extra paged requests.", "default": 25 }, "includeDirigeants": { "title": "Include directors (dirigeants)", "type": "boolean", "description": "Add the `dirigeants` array with the people and legal entities registered as company officers (role/qualité, first and last name, year and month of birth when published, nationality, SIREN for corporate officers). Useful for KYC, beneficial-ownership screening and prospecting by decision maker. Note that only published officers appear; natural persons can opt out of public diffusion, in which case names are absent.", "default": true }, "includeEtablissements": { "title": "Include matching establishments (sites)", "type": "boolean", "description": "Add the `etablissements` array with the secondary sites that matched the search: SIRET, address, city, activity, employee bracket, opening and closing dates, and coordinates. Leave it off for pure company-level enrichment; turn it on to map branches, multi-site groups or local prospects. Only establishments that matched the query are returned by the registry, not the full site list.", "default": false } } }, "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 } } } } } } } } } }