{
  "openapi": "3.0.1",
  "info": {
    "title": "SIRET Lookup & French Company Data | SIRENE API",
    "description": "Look up French companies by SIREN, SIRET, VAT number or company name using official SIRENE open data. Get legal name, address, NAF code, headcount and status. No emails or phone numbers are collected.",
    "version": "1.0",
    "x-build-id": "9flp190Md6c3M2VnS"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/atesen-software~french-company-enrichment-sirene/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-atesen-software-french-company-enrichment-sirene",
        "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/atesen-software~french-company-enrichment-sirene/runs": {
      "post": {
        "operationId": "runs-sync-atesen-software-french-company-enrichment-sirene",
        "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/atesen-software~french-company-enrichment-sirene/run-sync": {
      "post": {
        "operationId": "run-sync-atesen-software-french-company-enrichment-sirene",
        "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": {
          "mode": {
            "title": "Mode",
            "enum": [
              "lookup",
              "search"
            ],
            "type": "string",
            "description": "Lookup existing identifiers/names, or discover companies with activity and geographic filters.",
            "default": "lookup"
          },
          "identifiers": {
            "title": "SIREN, SIRET or VAT numbers",
            "type": "array",
            "description": "One per line. 9-digit SIREN, 14-digit SIRET or French VAT number (FR + 11 characters). Spaces, dots and dashes are ignored. Use 'Bulk edit' to paste a whole column from Excel or Google Sheets.",
            "items": {
              "type": "string"
            }
          },
          "csvText": {
            "title": "Paste SIREN/SIRET CSV (optional)",
            "maxLength": 1048576,
            "type": "string",
            "description": "Lookup mode only. Paste only identifier columns with siren and/or siret headers. Comma or semicolon separated; keep IDs as literal digits, including leading zeros. No file uploads or URLs. Maximum 1 MiB UTF-8, 1,000 data records and 1,000 combined input items including blank cells. Other columns are rejected. Input is stored normally by Apify; remove contact columns before pasting.",
            "default": ""
          },
          "companyNames": {
            "title": "Company names (find the SIREN)",
            "type": "array",
            "description": "One company name per line. Optionally add a postal code or department after a vertical bar to narrow the search, e.g. 'Decathlon | 59' or 'Boulangeries Paul | 59700'. Each row gets a match confidence score.",
            "items": {
              "type": "string"
            }
          },
          "minConfidence": {
            "title": "Minimum match confidence for names (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Name matches below this score are returned as 'low_confidence' with the candidate SIRENs listed, and are not charged. Lower it to accept fuzzier matches.",
            "default": 60
          },
          "onlyActiveCompanies": {
            "title": "Name search: active companies only",
            "type": "boolean",
            "description": "Name matching and search mode: return active legal units only. Does not filter exact identifier lookups or guarantee each branch is open.",
            "default": false
          },
          "includeFinances": {
            "title": "Include revenue and net income",
            "type": "boolean",
            "description": "Latest published revenue (chiffre d'affaires) and net income, when the company filed public accounts. Many small companies have none.",
            "default": true
          },
          "includeDirectors": {
            "title": "Include directors (names and roles)",
            "type": "boolean",
            "description": "Adds company officers from the national business register (RNE). This is personal data: only enable it if you have a lawful basis under GDPR. Birth dates and nationalities are never output.",
            "default": false
          },
          "validateOnly": {
            "title": "Free preview: validate input only",
            "type": "boolean",
            "description": "Checks every identifier (check digits, VAT key), removes duplicates and shows what would be looked up — without calling the registry and without any charge.",
            "default": false
          },
          "checkVat": {
            "title": "Validate VAT number in VIES",
            "type": "boolean",
            "description": "Check each company's intra-EU VAT number against the European Commission VIES service. Adds vatValid, vatViesName, vatViesAddress, vatCheckedAt and vatCheckError. Free add-on; slower (about 2 checks per second).",
            "default": false
          },
          "checkBodacc": {
            "title": "BODACC insolvency check (procédures collectives)",
            "type": "boolean",
            "description": "Look up insolvency notices (procédures collectives: redressement judiciaire, liquidation judiciaire, sauvegarde) published in the BODACC for each company. Adds bodaccHasProceedings, bodaccProcedure, bodaccJudgment, bodaccJudgmentDate, bodaccPublicationDate, bodaccTribunal, bodaccUrl and bodaccNoticesCount. Free add-on.",
            "default": false
          },
          "watchListName": {
            "title": "Watch list name (change detection)",
            "type": "string",
            "description": "Optional. Give a name (e.g. \"my-suppliers\") to remember the companies of this run. On the next run with the same name, every row gets watchStatus (new / changed / unchanged), changedFields and previousValues: status, closure, address, NAF code, headcount, legal form, revenue, directors and, if enabled, VAT validity and the latest BODACC notice. Schedule the run to monitor companies."
          },
          "maxRequestsPerSecond": {
            "title": "Max requests per second",
            "minimum": 1,
            "maximum": 7,
            "type": "integer",
            "description": "Upper bound for calls to the government API (its official limit is 7/s per IP, and it throttles harder under load). The Actor slows down automatically when throttled; you rarely need to change this.",
            "default": 2
          },
          "searchQuery": {
            "title": "Search text",
            "type": "string",
            "description": "Optional company name in search mode. Use identifiers for numeric SIREN/SIRET lookups."
          },
          "nafCode": {
            "title": "Company NAF / APE code",
            "type": "string",
            "description": "Search mode: exact legal-unit activity code, for example 62.01Z. This filters the company activity, not each branch activity."
          },
          "region": {
            "title": "Region code",
            "type": "string",
            "description": "Search mode: two-digit INSEE region, for example 11 (Ile-de-France). Matches establishments; company output may have its head office elsewhere."
          },
          "department": {
            "title": "Department code",
            "type": "string",
            "description": "Search mode: department such as 75, 59, 2A or 971."
          },
          "postalCode": {
            "title": "Postal code",
            "type": "string",
            "description": "Search mode: exact five-digit establishment postal code."
          },
          "outputMode": {
            "title": "Search output",
            "enum": [
              "companies",
              "establishments"
            ],
            "type": "string",
            "description": "Search mode: one row per company head office, or one per matching establishment with isHeadOffice and headOfficeSiret. API search windows apply.",
            "default": "companies"
          },
          "maxResults": {
            "title": "Maximum search results",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Search mode: maximum delivered rows. Lower this for a small first run. Also bounded by the run spending limit.",
            "default": 100
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}