{ "openapi": "3.0.1", "info": { "title": "Pappers Enrichment Bundle: Full French Company Profile", "description": "One enriched record per French company combining identity (SIREN, SIRET, name, address, NAF), financials (CA, resultat net), dirigeants (officers), establishments and GPS. Premium one-call upsell over pappers-sirene-scraper. For KYC, B2B prospecting, CRM enrichment.", "version": "1.0", "x-build-id": "wQ0cBLI50n5Rtuidb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dltik~pappers-enrichment-bundle/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dltik-pappers-enrichment-bundle", "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/dltik~pappers-enrichment-bundle/runs": { "post": { "operationId": "runs-sync-dltik-pappers-enrichment-bundle", "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/dltik~pappers-enrichment-bundle/run-sync": { "post": { "operationId": "run-sync-dltik-pappers-enrichment-bundle", "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": { "sirens": { "title": "SIREN / SIRET batch list", "type": "array", "description": "List of SIREN (9 digits) or SIRET (14 digits, will be truncated to SIREN). When provided, each entry is enriched and counted as one billable enrichment.", "items": { "type": "string" }, "default": [] }, "query": { "title": "Text query (alternative to sirens)", "type": "string", "description": "Free text used to discover companies if no sirens list is provided. Searches name, address, dirigeant. Example: 'boulangerie Lyon', 'Anthropic'." }, "departement": { "title": "Department code", "type": "string", "description": "Two-digit French department code (e.g. '75' for Paris, '69' for Rhône, '13' for Bouches-du-Rhône). Combine with query for narrower discovery." }, "code_postal": { "title": "Postal code", "type": "string", "description": "5-digit postal code (e.g. '75009', '69002') for discovery mode." }, "activite_principale": { "title": "NAF code", "type": "string", "description": "NAF/APE activity code for discovery mode (e.g. '62.01Z' for software, '56.10A' for restaurants)." }, "section_activite_principale": { "title": "NAF section", "type": "string", "description": "Single-letter NAF section for discovery mode (A=agriculture, C=manufacturing, F=construction, G=trade, J=info/comm, K=finance, M=consulting, Q=health)." }, "categorie_entreprise": { "title": "Company size category", "enum": [ "PME", "ETI", "GE" ], "type": "string", "description": "Discovery filter: PME (small/medium), ETI (intermediate), GE (large enterprise)." }, "tranche_effectif_salarie": { "title": "Employee bracket", "type": "string", "description": "INSEE employee bracket code for discovery (e.g. '11'=10-19, '21'=50-99, '31'=200-249, '41'=500-999)." }, "etat_administratif": { "title": "Administrative status", "enum": [ "A", "C" ], "type": "string", "description": "A = Active company, C = Ceased. Defaults to active companies only.", "default": "A" }, "ca_min": { "title": "Revenue minimum (EUR)", "minimum": 0, "type": "integer", "description": "Discovery filter: minimum CA (chiffre d'affaires) in euros. Only matches companies that filed accounts." }, "ca_max": { "title": "Revenue maximum (EUR)", "minimum": 0, "type": "integer", "description": "Discovery filter: maximum CA in euros." }, "includeEstablishments": { "title": "Include establishments array", "type": "boolean", "description": "When true, request up to N matching establishments from the gov API and include them in each enriched record. Only populated when a discovery query matches specific sites (siege HQ is always included).", "default": true }, "establishmentsLimit": { "title": "Establishments per company (max)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Hard cap on the number of matching establishments included per company when discovery filters match site fields.", "default": 10 }, "limit": { "title": "Max companies to enrich", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of companies enriched in one run. Counts as one billable company-enriched event per row.", "default": 50 } } }, "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 } } } } } } } } } }