{
  "openapi": "3.0.1",
  "info": {
    "title": "France Company Data & KYB - SIREN, SIRET, BODACC, Financials",
    "description": "French company lookup & due diligence from official SIRENE + BODACC data. Bulk SIREN/SIRET/VAT lookup or search by name, NAF, postcode: directors, revenue, insolvency & liquidation status, accounts filings, risk flags. Open-data alternative to Pappers / Societe.com for KYB, supplier checks, leads.",
    "version": "0.1",
    "x-build-id": "q2pkutTqOYmhcSo7E"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/rejoicing_shanty~france-company-due-diligence/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-rejoicing_shanty-france-company-due-diligence",
        "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/rejoicing_shanty~france-company-due-diligence/runs": {
      "post": {
        "operationId": "runs-sync-rejoicing_shanty-france-company-due-diligence",
        "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/rejoicing_shanty~france-company-due-diligence/run-sync": {
      "post": {
        "operationId": "run-sync-rejoicing_shanty-france-company-due-diligence",
        "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": {
          "companyIds": {
            "title": "SIREN / SIRET / VAT numbers",
            "type": "array",
            "description": "French company identifiers to look up: SIREN (9 digits, e.g. 552032534), SIRET (14 digits) or French VAT number (e.g. FR27552032534). Spaces and dots are ignored. Invalid or unknown identifiers return a free error record instead of failing the run.",
            "items": {
              "type": "string"
            }
          },
          "searchQuery": {
            "title": "Search: name, address or director",
            "type": "string",
            "description": "Optional free-text search across company names, addresses and directors (e.g. 'boulangerie lyon'). Can be combined with the filters below, or leave empty and use filters only."
          },
          "nafCodes": {
            "title": "NAF / APE activity codes",
            "type": "array",
            "description": "Filter by INSEE NAF rev.2 activity code, format 00.00X (e.g. 62.01Z software development, 56.10A restaurants).",
            "items": {
              "type": "string"
            }
          },
          "postalCodes": {
            "title": "Postal codes",
            "type": "array",
            "description": "Filter by establishment postal code (5 digits, e.g. 75008).",
            "items": {
              "type": "string"
            }
          },
          "departments": {
            "title": "Departments",
            "type": "array",
            "description": "Filter by department code (e.g. 75, 69, 2A, 971).",
            "items": {
              "type": "string"
            }
          },
          "legalFormCodes": {
            "title": "Legal form codes",
            "type": "array",
            "description": "Filter by INSEE legal category code (e.g. 5710 SAS, 5720 SASU, 5499 SARL, 5498 EURL, 5599 SA, 1000 sole trader).",
            "items": {
              "type": "string"
            }
          },
          "companyCategory": {
            "title": "Company size category",
            "enum": [
              "PME",
              "ETI",
              "GE"
            ],
            "type": "string",
            "description": "PME = SME, ETI = mid-cap, GE = large enterprise."
          },
          "employeeBands": {
            "title": "Employee bands",
            "type": "array",
            "description": "INSEE headcount bands: 01=1-2, 02=3-5, 03=6-9, 11=10-19, 12=20-49, 21=50-99, 22=100-199, 31=200-249, 32=250-499, 41=500-999, 42=1000-1999, 51=2000-4999, 52=5000-9999, 53=10000+.",
            "items": {
              "type": "string"
            }
          },
          "minRevenue": {
            "title": "Minimum revenue (EUR)",
            "type": "integer",
            "description": "Only companies whose latest published revenue is at least this amount."
          },
          "maxRevenue": {
            "title": "Maximum revenue (EUR)",
            "type": "integer",
            "description": "Only companies whose latest published revenue is at most this amount."
          },
          "directorName": {
            "title": "Director last name",
            "type": "string",
            "description": "Find companies where a person with this last name is a director (dirigeant)."
          },
          "activeOnly": {
            "title": "Active companies only (search)",
            "type": "boolean",
            "description": "When searching, return only companies that are still active. Direct SIREN lookups always return the company whatever its status.",
            "default": true
          },
          "maxResults": {
            "title": "Max search results",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Maximum companies returned by the search (direct identifier lookups are not limited by this).",
            "default": 50
          },
          "includeBodacc": {
            "title": "Include BODACC legal notices",
            "type": "boolean",
            "description": "Add official BODACC notices: insolvency proceedings (safeguard, receivership, liquidation) with current status, accounts filings, strike-off and recent notices. Recommended for due diligence; priced as a 'with BODACC' record.",
            "default": true
          },
          "maxBodaccNotices": {
            "title": "Recent BODACC notices",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "How many of the most recent BODACC notices to list per company (insolvency proceedings and accounts filings are always summarised separately).",
            "default": 10
          },
          "maxDirectors": {
            "title": "Max directors",
            "minimum": 0,
            "maximum": 200,
            "type": "integer",
            "description": "Maximum directors / officers returned per company.",
            "default": 30
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}