{"openapi":"3.0.0","paths":{"/health":{"get":{"operationId":"HealthController_ping","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthPingDto"}}}}},"summary":"Check if the API its UP and running","tags":["Health"]}},"/v1/acts":{"get":{"operationId":"ActsController_list","parameters":[{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return","schema":{"example":10,"type":"number"}},{"name":"page","required":false,"in":"query","description":"Page number to retrieve","schema":{"example":1,"type":"number"}},{"name":"siren","required":true,"in":"query","description":"SIREN like `552081317` or `582110987`","schema":{"nullable":false,"example":"552081317","type":"string"}}],"responses":{"200":{"description":"Paginated list of acts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActDtoPaginatedResponse"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"List acts by SIREN","tags":["Acts"]}},"/v1/acts/{id}":{"get":{"operationId":"ActsController_get","parameters":[{"name":"id","required":true,"in":"path","description":"Act ID","schema":{"example":"667550f1d4cf9b00dfe8ab76","type":"string"}}],"responses":{"200":{"description":"Act details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActDto"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Get act by ID","tags":["Acts"]}},"/v1/agreements":{"get":{"operationId":"AgreementsController_list","parameters":[{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return","schema":{"example":10,"type":"number"}},{"name":"page","required":false,"in":"query","description":"Page number to retrieve","schema":{"example":1,"type":"number"}},{"name":"siren","required":true,"in":"query","description":"SIREN like `552081317` or `582110987`","schema":{"nullable":false,"example":"552081317","type":"string"}}],"responses":{"200":{"description":"Paginated list of agreements","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgreementDtoPaginatedResponse"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"List agreements by SIREN","tags":["Agreements"]}},"/v1/agreements/{id}":{"get":{"operationId":"AgreementsController_get","parameters":[{"name":"id","required":true,"in":"path","description":"Agreement ID","schema":{"example":"686ca60036eebd8f9945b817","type":"string"}}],"responses":{"200":{"description":"Agreement details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgreementDto"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Get agreements by ID","tags":["Agreements"]}},"/v1/balancesheets":{"get":{"operationId":"BalancesheetsController_list","parameters":[{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return","schema":{"example":10,"type":"number"}},{"name":"page","required":false,"in":"query","description":"Page number to retrieve","schema":{"example":1,"type":"number"}},{"name":"siren","required":true,"in":"query","description":"SIREN like `552081317` or `582110987`","schema":{"nullable":false,"example":"552081317","type":"string"}}],"responses":{"200":{"description":"Paginated list of balancesheets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BalanceSheetDtoPaginatedResponse"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"List balancesheets by SIREN","tags":["Balancesheet"]}},"/v1/balancesheets/{id}":{"get":{"operationId":"BalancesheetsController_get","parameters":[{"name":"id","required":true,"in":"path","description":"Balancesheet ID","schema":{"example":"683e239d36eebd0d0b558d69","type":"string"}}],"responses":{"200":{"description":"Balancesheet details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BalanceSheetDto"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Get balancesheet by ID","tags":["Balancesheet"]}},"/v1/bodaccs":{"get":{"operationId":"BodaccsController_list","parameters":[{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return","schema":{"example":10,"type":"number"}},{"name":"page","required":false,"in":"query","description":"Page number to retrieve","schema":{"example":1,"type":"number"}},{"name":"siren","required":true,"in":"query","description":"SIREN like `552081317` or `582110987`","schema":{"nullable":false,"example":"552081317","type":"string"}}],"responses":{"200":{"description":"Paginated list of BODACCS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BodaccsDtoPaginatedResponse"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"List BODACCS by SIREN","tags":["BODACCS"]}},"/v1/bodaccs/{id}":{"get":{"operationId":"BodaccsController_get","parameters":[{"name":"id","required":true,"in":"path","description":"BODACCS ID","schema":{"example":"683b8a5436eebd4ae523012c","type":"string"}}],"responses":{"200":{"description":"BODACCS details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BodaccsDto"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Get BODACCS by ID","tags":["BODACCS"]}},"/v1/brands":{"get":{"operationId":"BrandsController_list","parameters":[{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return","schema":{"example":10,"type":"number"}},{"name":"page","required":false,"in":"query","description":"Page number to retrieve","schema":{"example":1,"type":"number"}},{"name":"siren","required":true,"in":"query","description":"SIREN like `552081317` or `582110987`","schema":{"nullable":false,"example":"552081317","type":"string"}}],"responses":{"200":{"description":"Paginated list of brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandDtoPaginatedResponse"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"List brands by SIREN","tags":["Brands"]}},"/v1/brands/{id}":{"get":{"operationId":"BrandsController_get","parameters":[{"name":"id","required":true,"in":"path","description":"Brand ID","schema":{"example":"64a0f357c3af5c1c032bfae3","type":"string"}}],"responses":{"200":{"description":"Brand details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandDto"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Get brand by ID","tags":["Brands"]}},"/v1/companies/search":{"get":{"operationId":"CompaniesController_search","parameters":[{"name":"search","required":false,"in":"query","description":"Search term","schema":{"title":"Search term","type":"string"}},{"name":"sortBy","required":false,"in":"query","description":"Sort field","schema":{"type":"string","enum":["organization_name","sales","netIncome","netMarginRate","availabilities","debts","equity","customerPaymentDelays","supplierPaymentDelays","valuation","grossMargin","ebitda","debtOverOneYear","workingCapitalRequirement","bankOutstanding","riskOfNonPayment","salariesAndExternalCharges","salariesAndSocialCharges","workingCapital","treasury","incomeTaxes","lastStaffMin","lastStaffMax","inventoryAndWorkInProgress","quotation","robustnessValue","rentabilityValue","solvencyNormalized","last_financial_count_patents","last_financial_count_brands","last_financial_count_procedures_collectives"]}},{"name":"sortOrder","required":false,"in":"query","description":"Sort order","schema":{"type":"string","enum":["ASC","DESC"]}},{"name":"apeCodes","required":false,"in":"query","description":"APE Codes","schema":{"title":"APE Codes","example":"6201Z,4511Z","type":"string"}},{"name":"statuses","required":false,"in":"query","description":"Organization Statuses","schema":{"title":"Status","type":"string"}},{"name":"postalCodes","required":false,"in":"query","description":"Postal Codes","schema":{"title":"Postal Codes","type":"string"}},{"name":"legalForms","required":false,"in":"query","description":"Organization Legal Form Codes","schema":{"title":"Legal Form","type":"string"}},{"name":"cities","required":false,"in":"query","description":"Cities","schema":{"title":"Cities","type":"string"}},{"name":"sectorCodes","required":false,"in":"query","description":"Sector Codes","schema":{"title":"Sector Codes","type":"string"}},{"name":"departments","required":false,"in":"query","description":"Departments Codes","schema":{"title":"Departments Codes","type":"string"}},{"name":"quotations","required":false,"in":"query","description":"Quotations","schema":{"type":"string"}},{"name":"sirens","required":false,"in":"query","description":"SIRENS","schema":{"title":"SIRENS","type":"string"}},{"name":"riskNonPaymentsNormalized","required":false,"in":"query","description":"Risk non payment","schema":{"title":"Risk non payment","type":"string"}},{"name":"inseeCategory","required":false,"in":"query","description":"INSEE Category","schema":{"title":"INSEE Category","type":"string"}},{"name":"staff","required":false,"in":"query","description":"Staff","schema":{"title":"Staff","type":"string"}},{"name":"regionCodes","required":false,"in":"query","description":"Region Codes","schema":{"title":"Region","type":"string"}},{"name":"minSales","required":false,"in":"query","description":"MIN Sales","schema":{"title":"MIN Sales","type":"number"}},{"name":"maxSales","required":false,"in":"query","description":"MAX Sales","schema":{"title":"MAX Sales","type":"number"}},{"name":"minNetIncome","required":false,"in":"query","description":"MIN Net Income","schema":{"title":"MIN Net Income","type":"number"}},{"name":"maxNetIncome","required":false,"in":"query","description":"MAX Net Income","schema":{"title":"MAX Net Income","type":"number"}},{"name":"minDebts","required":false,"in":"query","description":"MIN Debts","schema":{"title":"MIN Debts","type":"number"}},{"name":"maxDebts","required":false,"in":"query","description":"MAX Debts","schema":{"title":"MAX Debts","type":"number"}},{"name":"minEquity","required":false,"in":"query","description":"MIN Equity","schema":{"title":"MIN Equity","type":"number"}},{"name":"maxEquity","required":false,"in":"query","description":"MAX Equity","schema":{"title":"MAX Equity","type":"number"}},{"name":"minSharedCapital","required":false,"in":"query","description":"MIN Shared Capital","schema":{"title":"MIN Shared Capital","type":"number"}},{"name":"maxSharedCapital","required":false,"in":"query","description":"MAX Shared Capital","schema":{"title":"MAX Shared Capital","type":"number"}},{"name":"minGrossMargin","required":false,"in":"query","description":"MIN Gross Margin","schema":{"title":"MIN Gross Margin","type":"number"}},{"name":"maxGrossMargin","required":false,"in":"query","description":"MAX Gross Margin","schema":{"title":"MAX Gross Margin","type":"number"}},{"name":"minSalariesAndExternalCharges","required":false,"in":"query","description":"MIN Salaries and external charges","schema":{"title":"MIN Salaries and external charges","type":"number"}},{"name":"maxSalariesAndExternalCharges","required":false,"in":"query","description":"MAX Salaries and external charges","schema":{"title":"MAX Salaries and external charges","type":"number"}},{"name":"minWorkingCapitalRequirement","required":false,"in":"query","description":"MIN Working Capital Requirement","schema":{"title":"MIN Working Capital Requirement","type":"number"}},{"name":"maxWorkingCapitalRequirement","required":false,"in":"query","description":"MAX Working Capital Requirement","schema":{"title":"MAX Working Capital Requirement","type":"number"}},{"name":"minCustomerPaymentDelay","required":false,"in":"query","description":"MIN Customer Payment Delay","schema":{"title":"MIN Customer Payment Delay","type":"number"}},{"name":"maxCustomerPaymentDelay","required":false,"in":"query","description":"MAX Customer Payment Delay","schema":{"title":"MAX Customer Payment Delay","type":"number"}},{"name":"minWorkingCapital","required":false,"in":"query","description":"MIN Working Capital","schema":{"title":"MIN Working Capital","type":"number"}},{"name":"maxWorkingCapital","required":false,"in":"query","description":"MAX Working Capital","schema":{"title":"MAX Working Capital","type":"number"}},{"name":"minTreasury","required":false,"in":"query","description":"MIN Treasury","schema":{"title":"MIN Treasury","type":"number"}},{"name":"maxTreasury","required":false,"in":"query","description":"MAX Treasury","schema":{"title":"MAX Treasury","type":"number"}},{"name":"minDebtAfterOneYear","required":false,"in":"query","description":"MIN Debt After One year","schema":{"title":"MIN Debt After One year","type":"number"}},{"name":"maxDebtAfterOneYear","required":false,"in":"query","description":"MAX Debt After One year","schema":{"title":"MAX Debt After One year","type":"number"}},{"name":"minEbitda","required":false,"in":"query","description":"MIN EBITDA","schema":{"title":"MIN EBITDA","type":"number"}},{"name":"maxEbitda","required":false,"in":"query","description":"MAX EBITDA","schema":{"title":"MAX EBITDA","type":"number"}},{"name":"minIncomeTaxes","required":false,"in":"query","description":"MIN Income Taxes","schema":{"title":"MIN Income Taxes","type":"number"}},{"name":"maxIncomeTaxes","required":false,"in":"query","description":"MAX Income Taxes","schema":{"title":"MAX Income Taxes","type":"number"}},{"name":"minBankOutstanding","required":false,"in":"query","description":"MIN Bank Outstanding","schema":{"title":"MIN Bank Outstanding","type":"number"}},{"name":"maxBankOutstanding","required":false,"in":"query","description":"MAX Bank Outstanding","schema":{"title":"MAX Bank Outstanding","type":"number"}},{"name":"minValuation","required":false,"in":"query","description":"MIN Valuation","schema":{"title":"MIN Valuation","type":"number"}},{"name":"maxValuation","required":false,"in":"query","description":"MAX Valuation","schema":{"title":"MAX Valuation","type":"number"}},{"name":"minInventoryWorkInProgress","required":false,"in":"query","description":"MIN Inventory in progress","schema":{"title":"MIN Inventory in progress","type":"number"}},{"name":"maxInventoryWorkInProgress","required":false,"in":"query","description":"MAX Inventory in progress","schema":{"title":"MAX Inventory in progress","type":"number"}},{"name":"minCreationDate","required":false,"in":"query","description":"MIN Creation Date","schema":{"title":"MIN Creation Date","type":"string"}},{"name":"maxCreationDate","required":false,"in":"query","description":"MAX Creation Date","schema":{"title":"MAX Creation Date","type":"string"}},{"name":"fromCreationDate","required":false,"in":"query","description":"From Creation Date","schema":{"title":"From Creation Date","type":"string"}},{"name":"toCreationDate","required":false,"in":"query","description":"To Creation Date","schema":{"title":"To Creation Date","type":"string"}},{"name":"fromClosingDate","required":false,"in":"query","description":"From Closing Date","schema":{"title":"From Closing Date","type":"string"}},{"name":"toClosingDate","required":false,"in":"query","description":"To Closing Date","schema":{"title":"To Closing Date","type":"string"}},{"name":"fromCollectiveProcedureDate","required":false,"in":"query","description":"From Collective Procedure Date","schema":{"title":"From Collective Procedure Date","type":"string"}},{"name":"toCollectiveProcedureDate","required":false,"in":"query","description":"To Collective Procedure Date","schema":{"title":"To Collective Procedure Date","type":"string"}},{"name":"fromLastFinancialClosingDate","required":false,"in":"query","description":"From Last financial closing Date","schema":{"title":"From Last financial closing Date","type":"string"}},{"name":"toLastFinancialClosingDate","required":false,"in":"query","description":"To Last financial closing Date","schema":{"title":"To Last financial closing Date","type":"string"}},{"name":"collectiveProcedure","required":false,"in":"query","description":"Collective Procedure","schema":{"title":"Collective Procedure","example":"","type":"boolean"}},{"name":"includeForeigners","required":false,"in":"query","description":"Include Foreigners","schema":{"title":"Include Foreigners","example":"","type":"boolean"}},{"name":"isActive","required":false,"in":"query","description":"Is Active","schema":{"title":"Is Active","example":"","type":"boolean"}},{"name":"isProfitable","required":false,"in":"query","description":"Is Profitable","schema":{"title":"Is Profitable","example":"","type":"boolean"}},{"name":"isRespectfulOfPaymentDelays","required":false,"in":"query","description":"Is respectful of payment delays","schema":{"title":"Is respectful of payment delays","example":"","type":"boolean"}},{"name":"hasPhoneNumber","required":false,"in":"query","description":"Has phone number","schema":{"title":"Has phone number","example":"","type":"boolean"}},{"name":"hasLinkedin","required":false,"in":"query","description":"Has LinkedIn","schema":{"title":"Has LinkedIn","example":"","type":"boolean"}},{"name":"hasEmail","required":false,"in":"query","description":"Has Email","schema":{"title":"Has Email","example":"","type":"boolean"}},{"name":"hasTwitter","required":false,"in":"query","description":"Has Twitter","schema":{"title":"Has Twitter","example":"","type":"boolean"}},{"name":"hasWebsite","required":false,"in":"query","description":"Has Website","schema":{"title":"Has Website","example":"","type":"boolean"}},{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return","schema":{"example":10,"type":"number"}},{"name":"page","required":false,"in":"query","description":"Page number to retrieve","schema":{"example":1,"type":"number"}}],"responses":{"200":{"description":"Paginated company search results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesSearchItemDtoPaginatedResponse"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Search companies","tags":["Companies"]}},"/v1/companies/{sirenSiret}":{"get":{"operationId":"CompaniesController_get","parameters":[{"name":"sirenSiret","required":true,"in":"path","description":"SIREN (9 digits) or SIRET (14 digits)","schema":{"example":"552081317","type":"string"}}],"responses":{"200":{"description":"Company details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDto"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Get company by SIREN or SIRET","tags":["Companies"]}},"/v1/observations":{"get":{"operationId":"ObservationsController_list","parameters":[{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return","schema":{"example":10,"type":"number"}},{"name":"page","required":false,"in":"query","description":"Page number to retrieve","schema":{"example":1,"type":"number"}},{"name":"siren","required":true,"in":"query","description":"SIREN like `552081317` or `582110987`","schema":{"nullable":false,"example":"552081317","type":"string"}}],"responses":{"200":{"description":"Paginated list of observations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationsDtoPaginatedResponse"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"List observations by SIREN","tags":["Observations"]}},"/v1/observations/{id}":{"get":{"operationId":"ObservationsController_get","parameters":[{"name":"id","required":true,"in":"path","description":"Observation ID","schema":{"example":"680f215436eebd9cf400805c","type":"string"}}],"responses":{"200":{"description":"Observation details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationsDto"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Get observation by ID","tags":["Observations"]}},"/v1/officers/search":{"get":{"operationId":"OfficersController_search","parameters":[{"name":"firstname","required":false,"in":"query","description":"Firstname","schema":{"title":"Firstname","type":"string"}},{"name":"lastname","required":false,"in":"query","description":"Lastname","schema":{"title":"Lastname","type":"string"}},{"name":"search","required":false,"in":"query","description":"SIREN or SIRET","schema":{"title":"SIREN","type":"string"}},{"name":"minOfficerAge","required":false,"in":"query","description":"MIN Officer Age","schema":{"title":"MIN Officer Age","type":"number"}},{"name":"maxOfficerAge","required":false,"in":"query","description":"MAX Officer Age","schema":{"title":"MAX Officer Age","type":"number"}},{"name":"sortBy","required":false,"in":"query","description":"Sort field","schema":{"type":"string","enum":["officer_firstname","officer_lastname","officer_birth_date","total_mandates","main_company.organization_name","main_company.organization_capital_social","main_company.sales","main_company.netIncome","main_company.netMarginRate","main_company.availabilities","main_company.debts","main_company.equity","main_company.customerPaymentDelays","main_company.supplierPaymentDelays","main_company.valuation","main_company.grossMargin","main_company.ebitda","main_company.debtOverOneYear","main_company.workingCapitalRequirement","main_company.bankOutstanding","main_company.riskOfNonPayment","main_company.salariesAndExternalCharges","main_company.salariesAndSocialCharges","main_company.workingCapital","main_company.treasury","main_company.incomeTaxes","main_company.lastStaffMin","main_company.lastStaffMax","main_company.inventoryAndWorkInProgress","main_company.quotation","main_company.robustnessValue","main_company.rentabilityValue","main_company.solvencyNormalized"]}},{"name":"sortOrder","required":false,"in":"query","description":"Sort order","schema":{"type":"string","enum":["ASC","DESC"]}},{"name":"apeCodes","required":false,"in":"query","description":"APE Codes","schema":{"title":"APE Codes","example":"6201Z,4511Z","type":"string"}},{"name":"statuses","required":false,"in":"query","description":"Organization Statuses","schema":{"title":"Status","type":"string"}},{"name":"postalCodes","required":false,"in":"query","description":"Postal Codes","schema":{"title":"Postal Codes","type":"string"}},{"name":"legalForms","required":false,"in":"query","description":"Organization Legal Form Codes","schema":{"title":"Legal Form","type":"string"}},{"name":"cities","required":false,"in":"query","description":"Cities","schema":{"title":"Cities","type":"string"}},{"name":"sectorCodes","required":false,"in":"query","description":"Sector Codes","schema":{"title":"Sector Codes","type":"string"}},{"name":"departments","required":false,"in":"query","description":"Departments Codes","schema":{"title":"Departments Codes","type":"string"}},{"name":"quotations","required":false,"in":"query","description":"Quotations","schema":{"type":"string"}},{"name":"sirens","required":false,"in":"query","description":"SIRENS","schema":{"title":"SIRENS","type":"string"}},{"name":"riskNonPaymentsNormalized","required":false,"in":"query","description":"Risk non payment","schema":{"title":"Risk non payment","type":"string"}},{"name":"inseeCategory","required":false,"in":"query","description":"INSEE Category","schema":{"title":"INSEE Category","type":"string"}},{"name":"staff","required":false,"in":"query","description":"Staff","schema":{"title":"Staff","type":"string"}},{"name":"regionCodes","required":false,"in":"query","description":"Region Codes","schema":{"title":"Region","type":"string"}},{"name":"minSales","required":false,"in":"query","description":"MIN Sales","schema":{"title":"MIN Sales","type":"number"}},{"name":"maxSales","required":false,"in":"query","description":"MAX Sales","schema":{"title":"MAX Sales","type":"number"}},{"name":"minNetIncome","required":false,"in":"query","description":"MIN Net Income","schema":{"title":"MIN Net Income","type":"number"}},{"name":"maxNetIncome","required":false,"in":"query","description":"MAX Net Income","schema":{"title":"MAX Net Income","type":"number"}},{"name":"minDebts","required":false,"in":"query","description":"MIN Debts","schema":{"title":"MIN Debts","type":"number"}},{"name":"maxDebts","required":false,"in":"query","description":"MAX Debts","schema":{"title":"MAX Debts","type":"number"}},{"name":"minEquity","required":false,"in":"query","description":"MIN Equity","schema":{"title":"MIN Equity","type":"number"}},{"name":"maxEquity","required":false,"in":"query","description":"MAX Equity","schema":{"title":"MAX Equity","type":"number"}},{"name":"minSharedCapital","required":false,"in":"query","description":"MIN Shared Capital","schema":{"title":"MIN Shared Capital","type":"number"}},{"name":"maxSharedCapital","required":false,"in":"query","description":"MAX Shared Capital","schema":{"title":"MAX Shared Capital","type":"number"}},{"name":"minGrossMargin","required":false,"in":"query","description":"MIN Gross Margin","schema":{"title":"MIN Gross Margin","type":"number"}},{"name":"maxGrossMargin","required":false,"in":"query","description":"MAX Gross Margin","schema":{"title":"MAX Gross Margin","type":"number"}},{"name":"minSalariesAndExternalCharges","required":false,"in":"query","description":"MIN Salaries and external charges","schema":{"title":"MIN Salaries and external charges","type":"number"}},{"name":"maxSalariesAndExternalCharges","required":false,"in":"query","description":"MAX Salaries and external charges","schema":{"title":"MAX Salaries and external charges","type":"number"}},{"name":"minWorkingCapitalRequirement","required":false,"in":"query","description":"MIN Working Capital Requirement","schema":{"title":"MIN Working Capital Requirement","type":"number"}},{"name":"maxWorkingCapitalRequirement","required":false,"in":"query","description":"MAX Working Capital Requirement","schema":{"title":"MAX Working Capital Requirement","type":"number"}},{"name":"minCustomerPaymentDelay","required":false,"in":"query","description":"MIN Customer Payment Delay","schema":{"title":"MIN Customer Payment Delay","type":"number"}},{"name":"maxCustomerPaymentDelay","required":false,"in":"query","description":"MAX Customer Payment Delay","schema":{"title":"MAX Customer Payment Delay","type":"number"}},{"name":"minWorkingCapital","required":false,"in":"query","description":"MIN Working Capital","schema":{"title":"MIN Working Capital","type":"number"}},{"name":"maxWorkingCapital","required":false,"in":"query","description":"MAX Working Capital","schema":{"title":"MAX Working Capital","type":"number"}},{"name":"minTreasury","required":false,"in":"query","description":"MIN Treasury","schema":{"title":"MIN Treasury","type":"number"}},{"name":"maxTreasury","required":false,"in":"query","description":"MAX Treasury","schema":{"title":"MAX Treasury","type":"number"}},{"name":"minDebtAfterOneYear","required":false,"in":"query","description":"MIN Debt After One year","schema":{"title":"MIN Debt After One year","type":"number"}},{"name":"maxDebtAfterOneYear","required":false,"in":"query","description":"MAX Debt After One year","schema":{"title":"MAX Debt After One year","type":"number"}},{"name":"minEbitda","required":false,"in":"query","description":"MIN EBITDA","schema":{"title":"MIN EBITDA","type":"number"}},{"name":"maxEbitda","required":false,"in":"query","description":"MAX EBITDA","schema":{"title":"MAX EBITDA","type":"number"}},{"name":"minIncomeTaxes","required":false,"in":"query","description":"MIN Income Taxes","schema":{"title":"MIN Income Taxes","type":"number"}},{"name":"maxIncomeTaxes","required":false,"in":"query","description":"MAX Income Taxes","schema":{"title":"MAX Income Taxes","type":"number"}},{"name":"minBankOutstanding","required":false,"in":"query","description":"MIN Bank Outstanding","schema":{"title":"MIN Bank Outstanding","type":"number"}},{"name":"maxBankOutstanding","required":false,"in":"query","description":"MAX Bank Outstanding","schema":{"title":"MAX Bank Outstanding","type":"number"}},{"name":"minValuation","required":false,"in":"query","description":"MIN Valuation","schema":{"title":"MIN Valuation","type":"number"}},{"name":"maxValuation","required":false,"in":"query","description":"MAX Valuation","schema":{"title":"MAX Valuation","type":"number"}},{"name":"minInventoryWorkInProgress","required":false,"in":"query","description":"MIN Inventory in progress","schema":{"title":"MIN Inventory in progress","type":"number"}},{"name":"maxInventoryWorkInProgress","required":false,"in":"query","description":"MAX Inventory in progress","schema":{"title":"MAX Inventory in progress","type":"number"}},{"name":"minCreationDate","required":false,"in":"query","description":"MIN Creation Date","schema":{"title":"MIN Creation Date","type":"string"}},{"name":"maxCreationDate","required":false,"in":"query","description":"MAX Creation Date","schema":{"title":"MAX Creation Date","type":"string"}},{"name":"fromCreationDate","required":false,"in":"query","description":"From Creation Date","schema":{"title":"From Creation Date","type":"string"}},{"name":"toCreationDate","required":false,"in":"query","description":"To Creation Date","schema":{"title":"To Creation Date","type":"string"}},{"name":"fromClosingDate","required":false,"in":"query","description":"From Closing Date","schema":{"title":"From Closing Date","type":"string"}},{"name":"toClosingDate","required":false,"in":"query","description":"To Closing Date","schema":{"title":"To Closing Date","type":"string"}},{"name":"fromCollectiveProcedureDate","required":false,"in":"query","description":"From Collective Procedure Date","schema":{"title":"From Collective Procedure Date","type":"string"}},{"name":"toCollectiveProcedureDate","required":false,"in":"query","description":"To Collective Procedure Date","schema":{"title":"To Collective Procedure Date","type":"string"}},{"name":"fromLastFinancialClosingDate","required":false,"in":"query","description":"From Last financial closing Date","schema":{"title":"From Last financial closing Date","type":"string"}},{"name":"toLastFinancialClosingDate","required":false,"in":"query","description":"To Last financial closing Date","schema":{"title":"To Last financial closing Date","type":"string"}},{"name":"collectiveProcedure","required":false,"in":"query","description":"Collective Procedure","schema":{"title":"Collective Procedure","example":"","type":"boolean"}},{"name":"includeForeigners","required":false,"in":"query","description":"Include Foreigners","schema":{"title":"Include Foreigners","example":"","type":"boolean"}},{"name":"isActive","required":false,"in":"query","description":"Is Active","schema":{"title":"Is Active","example":"","type":"boolean"}},{"name":"isProfitable","required":false,"in":"query","description":"Is Profitable","schema":{"title":"Is Profitable","example":"","type":"boolean"}},{"name":"isRespectfulOfPaymentDelays","required":false,"in":"query","description":"Is respectful of payment delays","schema":{"title":"Is respectful of payment delays","example":"","type":"boolean"}},{"name":"hasPhoneNumber","required":false,"in":"query","description":"Has phone number","schema":{"title":"Has phone number","example":"","type":"boolean"}},{"name":"hasLinkedin","required":false,"in":"query","description":"Has LinkedIn","schema":{"title":"Has LinkedIn","example":"","type":"boolean"}},{"name":"hasEmail","required":false,"in":"query","description":"Has Email","schema":{"title":"Has Email","example":"","type":"boolean"}},{"name":"hasTwitter","required":false,"in":"query","description":"Has Twitter","schema":{"title":"Has Twitter","example":"","type":"boolean"}},{"name":"hasWebsite","required":false,"in":"query","description":"Has Website","schema":{"title":"Has Website","example":"","type":"boolean"}},{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return","schema":{"example":10,"type":"number"}},{"name":"page","required":false,"in":"query","description":"Page number to retrieve","schema":{"example":1,"type":"number"}}],"responses":{"200":{"description":"Paginated officer search results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfficerSearchResponseDtoPaginatedResponse"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Search Officers","tags":["Officers"]}},"/v1/officers/{id}":{"get":{"operationId":"OfficersController_get","parameters":[{"name":"id","required":true,"in":"path","description":"Officer ID","schema":{"example":"66aa3a635da7ac2c4b90d80d","type":"string"}}],"responses":{"200":{"description":"Officer details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfficerGetResponseDto"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"404":{"description":"Officer not found"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Get Officer","tags":["Officers"]}},"/v1/patents":{"get":{"operationId":"PatentsController_list","parameters":[{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return","schema":{"example":10,"type":"number"}},{"name":"page","required":false,"in":"query","description":"Page number to retrieve","schema":{"example":1,"type":"number"}},{"name":"siren","required":true,"in":"query","description":"SIREN like `552081317` or `582110987`","schema":{"nullable":false,"example":"552081317","type":"string"}}],"responses":{"200":{"description":"Paginated list of patents","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatentsDtoPaginatedResponse"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"List patents by SIREN","tags":["Patents"]}},"/v1/patents/search":{"get":{"operationId":"PatentsController_search","parameters":[{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return","schema":{"example":10,"type":"number"}},{"name":"page","required":false,"in":"query","description":"Page number to retrieve","schema":{"example":1,"type":"number"}},{"name":"search","required":true,"in":"query","description":"Search Example: `TEST`","schema":{"maxLength":255,"nullable":false,"example":"","type":"string"}},{"name":"apeCodes","required":false,"in":"query","description":"APE Codes Example: `6201Z,4511Z`","schema":{"title":"APE Codes","type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"SortOrder","schema":{"default":"DESC","type":"string","enum":["ASC","DESC"]}},{"name":"sortBy","required":false,"in":"query","description":"SortOrder","schema":{"type":"string","enum":["title","date_granted","date_searched_completed"]}}],"responses":{"200":{"description":"Paginated patent search results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatentsDtoPaginatedResponse"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Search patents","tags":["Patents"]}},"/v1/patents/{id}":{"get":{"operationId":"PatentsController_get","parameters":[{"name":"id","required":true,"in":"path","description":"Patent ID","schema":{"example":"6481d420c3af5c433e52a0c4","type":"string"}}],"responses":{"200":{"description":"Patent details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatentsDto"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Get patent by ID","tags":["Patents"]}},"/v1/procedures-collectives":{"get":{"operationId":"ProceduresCollectivesController_list","parameters":[{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return","schema":{"example":10,"type":"number"}},{"name":"page","required":false,"in":"query","description":"Page number to retrieve","schema":{"example":1,"type":"number"}},{"name":"siren","required":true,"in":"query","description":"SIREN like `552081317` or `582110987`","schema":{"nullable":false,"example":"552081317","type":"string"}}],"responses":{"200":{"description":"Paginated list of procedures collectives","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcedureCollectiveDtoPaginatedResponse"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"List procedures collectives by SIREN","tags":["Procedures Collectives"]}},"/v1/procedures-collectives/{id}":{"get":{"operationId":"ProceduresCollectivesController_get","parameters":[{"name":"id","required":true,"in":"path","description":"Procedure collective ID","schema":{"example":"68f1db6df9f6e4ab4f465fa5","type":"string"}}],"responses":{"200":{"description":"Procedure collective details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcedureCollectiveDto"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Get procedure collective by ID","tags":["Procedures Collectives"]}},"/v1/statutes":{"get":{"operationId":"StatutesController_list","parameters":[{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return","schema":{"example":10,"type":"number"}},{"name":"page","required":false,"in":"query","description":"Page number to retrieve","schema":{"example":1,"type":"number"}},{"name":"siren","required":true,"in":"query","description":"SIREN like `552081317` or `582110987`","schema":{"nullable":false,"example":"552081317","type":"string"}}],"responses":{"200":{"description":"Paginated list of statutes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatutesDtoPaginatedResponse"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"List statutes by SIREN","tags":["Statutes"]}},"/v1/statutes/{id}":{"get":{"operationId":"StatutesController_get","parameters":[{"name":"id","required":true,"in":"path","description":"Statute ID","schema":{"example":"667550f6d4cf9b00dfe922a4","type":"string"}}],"responses":{"200":{"description":"Statute details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatutesDto"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Get statute by ID","tags":["Statutes"]}},"/v1/account/balance":{"get":{"operationId":"AccountController_getBalance","parameters":[],"responses":{"200":{"description":"Current token balance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalUserBalanceResponseDto"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Invalid or missing API key"},"429":{"description":"Token quota exceeded"},"502":{"description":"Internal error"}},"security":[{"X-API-KEY-AUTH":[]}],"summary":"Get current token balance","tags":["Account"]}},"/v1/pdf/kbis":{"get":{"operationId":"PdfController_getKbisPdf","parameters":[{"name":"siren","required":true,"in":"query","description":"Company siren or siret","schema":{"nullable":false,"example":"57209392000062","type":"string"}}],"responses":{"200":{"description":"File download","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"X-API-KEY-AUTH":[]}],"tags":["Pdf"]}},"/v1/pdf/{type}":{"get":{"operationId":"PdfController_getPdf","parameters":[{"name":"type","required":true,"in":"path","description":"PDF type availables","schema":{"$ref":"#/components/schemas/PdfBasicTypeEnum"}},{"name":"siren","required":true,"in":"query","description":"Company siren or siret","schema":{"nullable":false,"example":"57209392000062","type":"string"}}],"responses":{"200":{"description":"File download","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"X-API-KEY-AUTH":[]}],"tags":["Pdf"]}},"/v1/pdf/id/{type}":{"get":{"operationId":"PdfController_getPdfWthRequirementId","parameters":[{"name":"type","required":true,"in":"path","description":"PDF type availables","schema":{"$ref":"#/components/schemas/PdfTypeWithIdRequirementEnum"}},{"name":"siren","required":true,"in":"query","description":"Company siren or siret","schema":{"nullable":false,"example":"57209392000062","type":"string"}},{"name":"documentId","required":true,"in":"query","description":"api document id","schema":{"nullable":false,"example":"69135918f8fd5fad9e0aafce","type":"string"}}],"responses":{"200":{"description":"File download","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"X-API-KEY-AUTH":[]}],"tags":["Pdf"]}},"/v1/pdf/document/{type}":{"get":{"operationId":"PdfController_getDocumentWthRequirementId","parameters":[{"name":"type","required":true,"in":"path","description":"Documents availables","schema":{"$ref":"#/components/schemas/OfficeDocEnum"}},{"name":"siren","required":true,"in":"query","description":"Company siren or siret","schema":{"nullable":false,"example":"57209392000062","type":"string"}},{"name":"documentId","required":true,"in":"query","description":"api document id","schema":{"nullable":false,"example":"69135918f8fd5fad9e0aafce","type":"string"}}],"responses":{"200":{"description":"File download","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"X-API-KEY-AUTH":[]}],"tags":["Pdf"]}}},"info":{"title":"Public API","description":"Used to provide API responses","version":"1.0","contact":{}},"tags":[{"name":"public-api","description":""}],"servers":[],"components":{"securitySchemes":{"X-API-KEY-AUTH":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"HealthPingDto":{"type":"object","properties":{"status":{"type":"string","example":"ok","description":"Api status"},"timestamp":{"type":"string","example":"2026-10-23T10:07:36.058Z","description":"Call Date"}},"required":["status","timestamp"]},"ActDecisionDto":{"type":"object","properties":{"type_acte":{"type":"string","description":"Act type code","example":"PJ_54","nullable":true},"decision":{"type":"string","description":"Decision text","example":"Modification de la dénomination sociale","nullable":true},"id":{"type":"string","description":"Decision unique identifier","example":"6474e08e9a3c3bff25a1d6b2","nullable":true}}},"ActDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN company identifier (9 digits)","example":"552081317","nullable":true},"id":{"type":"string","description":"Unique identifier","example":"6474e08e9a3c3bff25a1d6b2","nullable":true},"created_at":{"format":"date-time","type":"string","nullable":true,"description":"Creation date","example":"2026-01-15T10:30:00.000Z"},"downloadable":{"type":"boolean","nullable":true,"description":"Document is available for download","example":true},"decisions":{"description":"List of decisions","example":[],"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ActDecisionDto"}}}},"PaginationDto":{"type":"object","properties":{"total_results":{"type":"number","description":"Total number of results","example":100},"total_current_results":{"type":"number","description":"Number of results on the current page","example":10},"total_results_per_page":{"type":"number","description":"Number of results per page","example":10},"total_pages":{"type":"number","description":"Total number of pages","example":10},"current_page":{"type":"number","description":"Current page number","example":1}},"required":["total_results","total_current_results","total_results_per_page","total_pages","current_page"]},"ActDtoPaginatedResponse":{"type":"object","properties":{"results":{"description":"List of results on the current page","type":"array","items":{"$ref":"#/components/schemas/ActDto"}},"pagination":{"description":"Pagination metadata","allOf":[{"$ref":"#/components/schemas/PaginationDto"}]}},"required":["results","pagination"]},"AgreementDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN company identifier (9 digits)","example":"552081317","nullable":true},"id":{"type":"string","description":"Unique act identifier","example":"6474e08e9a3c3bff25a1d6b2","nullable":true},"date":{"format":"date-time","type":"string","nullable":true,"description":"Agreement date","example":"2026-01-15T10:30:00.000Z"},"title":{"type":"string","description":"Agreement title","example":"Agreement title","nullable":true},"themes":{"description":"Themes","example":["Système de prime (autre qu'évolution)","Heures supplémentaires (contingent, majoration)\""],"type":"array","items":{"type":"string"}}}},"AgreementDtoPaginatedResponse":{"type":"object","properties":{"results":{"description":"List of results on the current page","type":"array","items":{"$ref":"#/components/schemas/AgreementDto"}},"pagination":{"description":"Pagination metadata","allOf":[{"$ref":"#/components/schemas/PaginationDto"}]}},"required":["results","pagination"]},"BalanceSheetDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN company identifier (9 digits)","example":"552081317","nullable":true},"id":{"type":"string","description":"Unique identifier","example":"683e239d36eebd0d0b558d69","nullable":true},"presentation_date":{"format":"date-time","type":"string","nullable":true,"description":"Date","example":"2026-01-15T10:30:00.000Z"},"closing_date":{"format":"date-time","type":"string","nullable":true,"description":"Closing Date","example":"2026-01-15T10:30:00.000Z"},"company_ape_code":{"type":"string","description":"Company APE Code","example":"6430Z","nullable":true},"company_sector_code":{"type":"string","description":"Company Section Code","example":"02","nullable":true},"confidentiality":{"type":"string","description":"Confidentiality","example":"02","nullable":true},"document_name":{"type":"string","description":"Document name","example":"document_name","nullable":true},"num_chrono":{"type":"string","description":"Num chrono","example":"34644","nullable":true},"type_code":{"type":"string","description":"Type Code","example":"C","nullable":true},"version":{"type":"string","description":"Version","example":"2.0","nullable":true}}},"BalanceSheetDtoPaginatedResponse":{"type":"object","properties":{"results":{"description":"List of results on the current page","type":"array","items":{"$ref":"#/components/schemas/BalanceSheetDto"}},"pagination":{"description":"Pagination metadata","allOf":[{"$ref":"#/components/schemas/PaginationDto"}]}},"required":["results","pagination"]},"BodaccsDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN company identifier (9 digits)","example":"552081317","nullable":true},"id":{"type":"string","description":"Unique BODACCS identifier","example":"687d756cf9f6e4fbb6102506","nullable":true},"title":{"type":"string","description":"BODACCS Title","example":"Modifications et mutations diverses","nullable":true},"date":{"format":"date-time","type":"string","nullable":true,"description":"Date","example":"2025-05-31T00:00:00.000Z"},"description":{"type":"string","description":"Description","example":"modification survenue sur l'administration","nullable":true}}},"BodaccsDtoPaginatedResponse":{"type":"object","properties":{"results":{"description":"List of results on the current page","type":"array","items":{"$ref":"#/components/schemas/BodaccsDto"}},"pagination":{"description":"Pagination metadata","allOf":[{"$ref":"#/components/schemas/PaginationDto"}]}},"required":["results","pagination"]},"BrandDescriptionDto":{"type":"object","properties":{"number":{"type":"string","description":"Number","example":"1","nullable":true},"description":{"type":"string","description":"Description text","example":"Appareils électriques","nullable":true}}},"BrandDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN company identifier (9 digits)","example":"552081317","nullable":true},"id":{"type":"string","description":"Brand ID","example":"64a0f357c3af5c1c032bfae3","nullable":true},"date":{"format":"date-time","type":"string","nullable":true,"description":"Date","example":"2026-01-15T00:00:00.000Z"},"expiry_date":{"format":"date-time","type":"string","nullable":true,"description":"Expiry date","example":"2033-01-15T00:00:00.000Z"},"brand_application_number":{"type":"string","description":"Brand application number","example":"FR95573561","nullable":true},"applicant_name":{"type":"string","description":"Applicant name","example":"ELECTRICITE DE FRANCE","nullable":true},"name":{"type":"string","description":"Brand name","example":"EDF","nullable":true},"descriptions":{"description":"Brand descriptions","nullable":true,"type":"array","items":{"$ref":"#/components/schemas/BrandDescriptionDto"}},"brand_type":{"type":"string","description":"Brand type","example":"WORD","nullable":true},"status":{"type":"string","description":"Brand status","example":"Marque expirée","nullable":true},"internal_cdn_file_path":{"type":"string","description":"Internal CDN fil path","example":"companies/myfile.webp","nullable":true},"downloadable":{"type":"boolean","nullable":true,"description":"Document is available for download","example":true},"company_ape_code":{"type":"string","description":"Ape code","example":"3511Z","nullable":true},"company_sector_code":{"type":"string","description":"Sector code","example":"35","nullable":true}}},"BrandDtoPaginatedResponse":{"type":"object","properties":{"results":{"description":"List of results on the current page","type":"array","items":{"$ref":"#/components/schemas/BrandDto"}},"pagination":{"description":"Pagination metadata","allOf":[{"$ref":"#/components/schemas/PaginationDto"}]}},"required":["results","pagination"]},"CompaniesColumnValueDto":{"type":"object","properties":{"value":{"type":"number","nullable":true,"description":"Current value","example":1500000},"previous":{"type":"number","nullable":true,"description":"Previous year value","example":1400000},"variation":{"type":"number","nullable":true,"description":"Variation","example":7.14},"year":{"type":"number","nullable":true,"description":"Reference year","example":2024},"previous_year":{"type":"number","nullable":true,"description":"Previous reference year","example":2023}}},"CompaniesSearchItemDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN number (9 digits)","example":"552081317"},"siret":{"type":"string","description":"SIRET number (14 digits)","example":"55208131700014"},"organization_status":{"type":"string","description":"Organization status","example":"active"},"organization_creation_date":{"type":"string","description":"Organization creation date","example":"2010-01-01"},"organization_closing_date":{"type":"object","description":"Organization closing date","example":"2025-12-31"},"organization_name":{"type":"string","description":"Organization name","example":"ELECTRICITE DE FRANCE"},"organization_business_name":{"type":"string","description":"Business name with alternative","example":"EDF SA"},"address_street":{"type":"string","description":"Street address","example":"22 Avenue de Wagram"},"address_postal_code":{"type":"string","description":"Postal code","example":"75008"},"address_department":{"type":"string","description":"Department code","example":"75"},"address_city":{"type":"string","description":"City name","example":"Paris"},"address_country_code":{"type":"string","description":"Country code","example":"FR"},"address_formatted":{"type":"string","description":"Formatted address","example":"22 Avenue de Wagram, 75008 Paris"},"address_display":{"type":"string","description":"Display address","example":"75008 Paris"},"address_lat":{"type":"number","description":"Latitude","example":48.878},"address_lng":{"type":"number","description":"Longitude","example":2.295},"legal_name":{"type":"string","description":"Legal form name","example":"SAS"},"activity_ape_code":{"type":"string","description":"APE activity code","example":"3511Z"},"activity_sector_code":{"type":"string","description":"Sector code","example":"35"},"quotation":{"description":"quotation","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"sales":{"description":"sales","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"netIncome":{"description":"netIncome","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"netMarginRate":{"description":"netMarginRate","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"availabilities":{"description":"availabilities","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"debts":{"description":"debts","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"equity":{"description":"equity","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"customerPaymentDelays":{"description":"customerPaymentDelays","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"supplierPaymentDelays":{"description":"supplierPaymentDelays","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"valuation":{"description":"valuation","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"grossMargin":{"description":"grossMargin","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"ebitda":{"description":"ebitda","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"debtOverOneYear":{"description":"debtOverOneYear","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"workingCapitalRequirement":{"description":"workingCapitalRequirement","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"bankOutstanding":{"description":"bankOutstanding","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"riskOfNonPayment":{"description":"riskOfNonPayment","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"salariesAndExternalCharges":{"description":"salariesAndExternalCharges","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"salariesAndSocialCharges":{"description":"salariesAndSocialCharges","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"workingCapital":{"description":"workingCapital","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"treasury":{"description":"treasury","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"incomeTaxes":{"description":"incomeTaxes","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"lastStaffMin":{"description":"lastStaffMin","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"lastStaffMax":{"description":"lastStaffMax","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"inventoryAndWorkInProgress":{"description":"inventoryAndWorkInProgress","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"robustnessValue":{"description":"robustnessValue","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"rentabilityValue":{"description":"rentabilityValue","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]},"solvencyNormalized":{"description":"solvencyNormalized","allOf":[{"$ref":"#/components/schemas/CompaniesColumnValueDto"}]}}},"CompaniesSearchItemDtoPaginatedResponse":{"type":"object","properties":{"results":{"description":"List of results on the current page","type":"array","items":{"$ref":"#/components/schemas/CompaniesSearchItemDto"}},"pagination":{"description":"Pagination metadata","allOf":[{"$ref":"#/components/schemas/PaginationDto"}]}},"required":["results","pagination"]},"CompanyActivityDto":{"type":"object","properties":{"ape_code":{"type":"string","description":"APE code","example":"3511Z","nullable":true},"formatted_ape_code":{"type":"string","description":"Formatted APE code","example":"35.11Z","nullable":true},"ape_name":{"type":"string","description":"APE activity name","example":"Production d'électricité","nullable":true},"description":{"type":"string","description":"Activity description","example":"Production et distribution d'électricité","nullable":true},"sector_code":{"type":"string","description":"Sector code","example":"35","nullable":true}}},"CompanyAddressDto":{"type":"object","properties":{"postal_address_additional_name":{"type":"string","description":"Additional name","example":"Address name","nullable":true},"street":{"type":"string","description":"Street name","example":"Avenue de la rue","nullable":true},"street_type":{"type":"string","description":"Street type","example":"Avenue","nullable":true},"street_number":{"type":"string","description":"Street number","example":"22","nullable":true},"formatted_street":{"type":"string","description":"Formatted street","example":"22 Avenue de la rue","nullable":true},"postal_code":{"type":"string","description":"Postal code","example":"75008","nullable":true},"department":{"type":"string","description":"Department code","example":"75","nullable":true},"city":{"type":"string","description":"City name","example":"Paris","nullable":true},"formatted_address":{"type":"string","description":"Full formatted address","example":"22 Avenue de de la rue, 75008 Paris","nullable":true},"country_code":{"type":"string","description":"Country code","example":"FR","nullable":true},"country":{"type":"string","description":"Country name","example":"France","nullable":true},"lng":{"type":"number","nullable":true,"description":"Longitude","example":2.295},"lat":{"type":"number","nullable":true,"description":"Latitude","example":48.878}}},"CompanyConventionCollectiveDto":{"type":"object","properties":{"code":{"type":"string","description":"Convention collective code","example":"1486","nullable":true},"name":{"type":"string","description":"Convention collective name","example":"Bureaux d'études techniques","nullable":true}}},"CompanyLegalDto":{"type":"object","properties":{"code":{"type":"string","description":"Code","example":"5710","nullable":true},"name":{"type":"string","description":"Name","example":"SAS","nullable":true},"person_type":{"type":"string","description":"Person type","example":"LegalEntity","nullable":true},"type":{"type":"string","description":"Type","example":"Siege","nullable":true}}},"CompanyOrganizationDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN company identifier (9 digits)","example":"552081317","nullable":true},"siret":{"type":"string","description":"SIRET number (14 digits)","example":"55208131700014","nullable":true},"status":{"type":"string","description":"Organization status","example":"Active","nullable":true},"data_can_be_displayed":{"type":"boolean","nullable":true,"description":"Data can be displayed","example":true},"address_diffusibility":{"type":"string","description":"Address diffusibility","example":"diffusible","nullable":true},"financial_can_be_displayed":{"type":"boolean","nullable":true,"description":"Financial data can be displayed","example":true},"diffusibility":{"type":"string","description":"Diffusibility status","example":"diffusible","nullable":true},"creation_date":{"type":"string","description":"Creation date","example":"2010-01-01","nullable":true},"creation_date_formatted":{"format":"date-time","type":"string","nullable":true,"description":"Formatted creation date","example":"2010-01-01T00:00:00.000Z"},"closing_date":{"type":"string","description":"Closing date","example":"2025-12-31","nullable":true},"closing_date_formatted":{"format":"date-time","type":"string","nullable":true,"description":"Formatted closing date","example":"2025-12-31T00:00:00.000Z"},"last_legal_update_date":{"type":"string","description":"Last legal update date","example":"2024-06-01","nullable":true},"last_legal_update_date_formatted":{"format":"date-time","type":"string","nullable":true,"description":"Formatted last legal update","example":"2024-06-01T00:00:00.000Z"},"vat_number":{"type":"string","description":"VAT number","example":"FR03552081317","nullable":true},"nic":{"type":"string","description":"NIC code","example":"66522","nullable":true},"name_without_alternative":{"type":"string","description":"Name without alternative","example":"ELECTRICITE DE FRANCE","nullable":true},"name_alternative":{"type":"string","description":"Alternative name","example":"EDF","nullable":true},"name":{"type":"string","description":"Organization name","example":"ELECTRICITE DE FRANCE","nullable":true},"greffe_name":{"type":"string","description":"Greffe name","example":"PARIS","nullable":true},"business_name":{"type":"string","description":"Business name","example":"EDF","nullable":true},"description":{"type":"string","description":"Description","example":"Production d'électricité","nullable":true},"rne_date":{"format":"date-time","type":"string","nullable":true,"description":"RNE registration date","example":"2010-01-01T00:00:00.000Z"},"rcs_date":{"format":"date-time","type":"string","nullable":true,"description":"RCS registration date","example":"2010-01-01T00:00:00.000Z"},"rcs_closing_date":{"format":"date-time","type":"string","nullable":true,"description":"RCS closing date","example":"2025-12-31T00:00:00.000Z"},"headquarter_status":{"type":"string","description":"Headquarter status","example":"Active","nullable":true}}},"CompanyRiskDto":{"type":"object","properties":{"risk_level":{"type":"string","description":"Risk level","example":"0","nullable":true},"risk_level_description":{"type":"string","description":"Risk level description","example":"Pas de risque identifié","nullable":true}}},"CompanyInseeCategoryDto":{"type":"object","properties":{"code":{"type":"string","description":"INSEE category code","example":"GE","nullable":true},"name":{"type":"string","description":"INSEE category name","example":"Grande entreprise","nullable":true}}},"CompanyOfficerDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN company identifier (9 digits)","example":"552081317","nullable":true},"siret":{"type":"string","description":"SIRET number (14 digits)","example":"55208131700014","nullable":true},"type":{"type":"string","description":"Officer type","enum":["P.Physique","P.Morale"],"example":"P.Physique"},"firstname":{"type":"string","description":"Firstname","example":"John","nullable":true},"lastname":{"type":"string","description":"Lastname","example":"Smith","nullable":true},"full_name_tokenized":{"type":"string","description":"Full Name tokenized","example":"john smith","nullable":true},"organization_name":{"type":"string","description":"Enteprise Name","example":"Entreprise Name","nullable":true},"organization_name_without_alternative":{"type":"string","description":"entreprise name","example":"entreprise name","nullable":true},"role":{"type":"string","description":"Role","example":"Directeur Général","nullable":true},"role_code":{"type":"string","description":"Role Code","example":"Role code","nullable":true},"internal_officer_group_id":{"type":"string","description":"Internal Officer Group ID","example":"683e239d36eebd0d0b558d69","nullable":true},"internal_officer_id":{"type":"string","description":"Internal Officer ID","example":"6474e08e9a3c3bff25a1d6b2","nullable":true}}},"CompanyContactsDto":{"type":"object","properties":{"email":{"type":"string","description":"Company email","example":"contact@entreprise-example.com","nullable":true},"website_url":{"type":"string","description":"Company website","example":"https://entreprise-example.com","nullable":true},"linkedin":{"type":"string","description":"Company LinkedIn","example":"https://linkedin.com/in/entreprise-example.com","nullable":true},"linkedin_description":{"type":"string","description":"LinkedIn description","example":"LinkedIn description","nullable":true},"twitter":{"type":"string","description":"Twitter (X)","example":"https://x.com/entreprise-example","nullable":true},"facebook":{"type":"string","description":"Facebook","example":"https://facebook.com/entreprise-example","nullable":true},"wikipedia":{"type":"string","description":"Wikipedia","example":"https://wikipedia.com/entreprise-example","nullable":true},"youtube":{"type":"string","description":"Youtube","example":"https://youtube.com/entreprise-example","nullable":true},"instagram":{"type":"string","description":"Instagram","example":"https://instagram.com/entreprise-example","nullable":true},"phones":{"description":"Company Phones","example":["+33 123456789"],"type":"array","items":{"type":"string"}},"emails":{"description":"Company emails","example":["contact@entreprise-example.com","hello@entreprise-example.com"],"type":"array","items":{"type":"string"}},"websites_urls":{"description":"Website emails","example":["https://entreprise-example.com","https://landing.entreprise-example.com"],"type":"array","items":{"type":"string"}}}},"KeyfactDto":{"type":"object","properties":{"year":{"type":"number","nullable":true,"description":"Reference year","example":2026},"value":{"type":"number","nullable":true,"description":"Current value","example":1500000},"previous_value":{"type":"number","nullable":true,"description":"Previous year value","example":1400000},"previous_year":{"type":"number","nullable":true,"description":"Previous reference year","example":2025},"variation":{"type":"number","nullable":true,"description":"Variation","example":7.14},"increased":{"type":"string","description":"Variation direction sign","enum":["+","-","="],"example":"+"}}},"CompanyKeyfactsDto":{"type":"object","properties":{"quotation":{"nullable":true,"description":"Quotation","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"sales":{"nullable":true,"description":"Sales","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"netIncome":{"nullable":true,"description":"Net income","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"netMarginRate":{"nullable":true,"description":"Net margin rate","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"availabilities":{"nullable":true,"description":"Availabilities","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"debts":{"nullable":true,"description":"Total debts","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"equity":{"nullable":true,"description":"Equity","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"customerPaymentDelays":{"nullable":true,"description":"Customer payment delays","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"supplierPaymentDelays":{"nullable":true,"description":"Supplier payment delays","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"valuation":{"nullable":true,"description":"Valuation","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"grossMargin":{"nullable":true,"description":"Gross margin","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"ebitda":{"nullable":true,"description":"EBITDA","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"debtOverOneYear":{"nullable":true,"description":"Debt over one year","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"workingCapitalRequirement":{"nullable":true,"description":"Working capital requirement","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"bankOutstanding":{"nullable":true,"description":"Bank outstanding","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"riskOfNonPayment":{"nullable":true,"description":"Risk of non-payment","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"salariesAndExternalCharges":{"nullable":true,"description":"Salaries and external charges","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"workingCapital":{"nullable":true,"description":"Working capital","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"treasury":{"nullable":true,"description":"Treasury","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"incomeTaxes":{"nullable":true,"description":"Income taxes","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"lastStaffMin":{"nullable":true,"description":"Last staff min","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"lastStaffMax":{"nullable":true,"description":"Last staff max","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"inventoryAndWorkInProgress":{"nullable":true,"description":"Inventory and work in progress","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"robustnessValue":{"nullable":true,"description":"Robustness","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"rentabilityValue":{"nullable":true,"description":"Rentability","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"salariesAndSocialCharges":{"nullable":true,"description":"Salaries and social charges","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]},"solvencyNormalized":{"nullable":true,"description":"Solvency normalized","type":"object","allOf":[{"$ref":"#/components/schemas/KeyfactDto"}]}}},"CompanyDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN company identifier (9 digits)","example":"552081317","nullable":true},"siret":{"type":"string","description":"SIRET number (14 digits)","example":"55208131700014","nullable":true},"capital_social":{"type":"number","nullable":true,"description":"Capital social","example":10000},"logo_image_available":{"type":"boolean","nullable":true,"description":"Logo image is available","example":true},"logo_image_cdn":{"type":"string","description":"Logo image CDN URL","example":"https://cdn.example.com/logo.png","nullable":true},"internal_import_log_id":{"type":"string","description":"Internal import log ID","example":"6474e08e9a3c3bff25a1d6b2","nullable":true},"id":{"type":"string","description":"Company ID","example":"6474e08e9a3c3bff25a1d6b2","nullable":true},"has_main_officer":{"type":"number","nullable":true,"description":"Company has a main officer","example":1},"main_officer_full_name_tokenized":{"type":"string","description":"Main officer full name","example":"Jean Dupont","nullable":true},"activity":{"nullable":true,"description":"Company activity information","type":"object","allOf":[{"$ref":"#/components/schemas/CompanyActivityDto"}]},"address":{"nullable":true,"description":"Company address","type":"object","allOf":[{"$ref":"#/components/schemas/CompanyAddressDto"}]},"convention_collective":{"nullable":true,"description":"Collective agreement","type":"object","allOf":[{"$ref":"#/components/schemas/CompanyConventionCollectiveDto"}]},"legal":{"nullable":true,"description":"Legal information","type":"object","allOf":[{"$ref":"#/components/schemas/CompanyLegalDto"}]},"organization":{"nullable":true,"description":"Organization details","type":"object","allOf":[{"$ref":"#/components/schemas/CompanyOrganizationDto"}]},"risk":{"nullable":true,"description":"Risk assessment","type":"object","allOf":[{"$ref":"#/components/schemas/CompanyRiskDto"}]},"insee_category":{"nullable":true,"description":"INSEE category","type":"object","allOf":[{"$ref":"#/components/schemas/CompanyInseeCategoryDto"}]},"officers":{"description":"Company officers","nullable":true,"type":"array","items":{"$ref":"#/components/schemas/CompanyOfficerDto"}},"company_contacts":{"nullable":true,"description":"Company contacts","type":"object","allOf":[{"$ref":"#/components/schemas/CompanyContactsDto"}]},"company_keyfacts":{"nullable":true,"description":"Company key financial facts","type":"object","allOf":[{"$ref":"#/components/schemas/CompanyKeyfactsDto"}]}}},"ObservationsDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN company identifier (9 digits)","example":"552081317","nullable":true},"id":{"type":"string","description":"Observation ID","example":"680f215436eebd9cf400805c","nullable":true},"created_at":{"format":"date-time","type":"string","nullable":true,"description":"Observation creation date","example":"2023-01-15T00:00:00.000Z"},"text":{"type":"string","description":"Observation text","example":"Observation sur la société","nullable":true},"observation_state":{"type":"string","description":"Observation state","example":"Rectification","nullable":true},"num_observation":{"type":"string","description":"Observation number","example":"1958B11098186","nullable":true},"id_observation":{"type":"string","description":"Observation identifier","example":"186","nullable":true}}},"ObservationsDtoPaginatedResponse":{"type":"object","properties":{"results":{"description":"List of results on the current page","type":"array","items":{"$ref":"#/components/schemas/ObservationsDto"}},"pagination":{"description":"Pagination metadata","allOf":[{"$ref":"#/components/schemas/PaginationDto"}]}},"required":["results","pagination"]},"OfficerOrganizationDto":{"type":"object","properties":{"status":{"type":"string","description":"Organization status","example":"active"},"creation_date":{"type":"string","description":"Organization creation date","example":"2010-01-01"},"closing_date":{"type":"string","description":"Organization closing date","example":"2025-12-31"},"siren":{"type":"string","description":"SIREN number (9 digits)","example":"552081317"},"siret":{"type":"string","description":"SIRET number (14 digits)","example":"55208131700014"},"name":{"type":"string","description":"Organization name","example":"ELECTRICITE DE FRANCE"},"business_name":{"type":"string","description":"Legal form","example":"SA"},"vat_number":{"type":"string","description":"VAT number","example":"FR03552081317"},"phone":{"type":"string","description":"Phone number","example":"0144443333"},"email":{"type":"string","description":"Email address","example":"contact@edf.fr"},"website":{"type":"string","description":"Website URL","example":"https://www.edf.fr"}}},"MandateDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN number (9 digits)","example":"552081317","nullable":true},"siret":{"type":"string","description":"SIRET number (14 digits)","example":"55208131700014","nullable":true},"organizationName":{"type":"string","description":"Organization name","example":"ELECTRICITE DE FRANCE","nullable":true},"organizationNameWithoutAlternative":{"type":"string","description":"Organization name without alternative","example":"ELECTRICITE DE FRANCE","nullable":true},"role":{"type":"string","description":"Officer role","example":"Président de SAS","nullable":true},"roleCode":{"type":"string","description":"Role code","example":"Président de SAS","nullable":true},"_id":{"type":"string","description":"Mandate ID","example":"6474e08e9a3c3bff25a1d6b2","nullable":true}}},"OfficerSearchResponseDto":{"type":"object","properties":{"id":{"type":"string","description":"Officer group ID","example":"683e239d36eebd0d0b558d69"},"firstname":{"type":"string","description":"Officer firstname","example":"Jean"},"lastname":{"type":"string","description":"Officer lastname","example":"Dupont"},"type":{"type":"string","description":"Officer type","example":"P.Physique"},"birthdate":{"type":"string","description":"Officer birth date","example":"1980-01-01"},"role":{"type":"string","description":"Main role in company","example":"Président"},"organization":{"description":"Main company organization","allOf":[{"$ref":"#/components/schemas/OfficerOrganizationDto"}]},"total_mandates":{"type":"number","description":"Total number of mandates","example":3},"mandates":{"description":"List of mandates","type":"array","items":{"$ref":"#/components/schemas/MandateDto"}}}},"OfficerSearchResponseDtoPaginatedResponse":{"type":"object","properties":{"results":{"description":"List of results on the current page","type":"array","items":{"$ref":"#/components/schemas/OfficerSearchResponseDto"}},"pagination":{"description":"Pagination metadata","allOf":[{"$ref":"#/components/schemas/PaginationDto"}]}},"required":["results","pagination"]},"CompanyMandateDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN number (9 digits)","example":"552081317","nullable":true},"siret":{"type":"string","description":"SIRET number (14 digits)","example":"55208131700014","nullable":true},"organizationName":{"type":"string","description":"Organization name","example":"ELECTRICITE DE FRANCE","nullable":true},"organizationNameWithoutAlternative":{"type":"string","description":"Organization name without alternative","example":"ELECTRICITE DE FRANCE","nullable":true},"role":{"type":"string","description":"Officer role","example":"Président de SAS","nullable":true},"roleCode":{"type":"string","description":"Role code","example":"Président de SAS","nullable":true}}},"MainComandatoryDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN number (9 digits)","example":"552081317","nullable":true},"siret":{"type":"string","description":"SIRET number (14 digits)","example":"55208131700014","nullable":true},"organizationName":{"type":"string","description":"Organization name","example":"ELECTRICITE DE FRANCE","nullable":true},"organizationNameWithoutAlternative":{"type":"string","description":"Organization name without alternative","example":"ELECTRICITE DE FRANCE","nullable":true},"role":{"type":"string","description":"Officer role","example":"Président de SAS","nullable":true},"roleCode":{"type":"string","description":"Role code","example":"Président de SAS","nullable":true},"type":{"type":"string","description":"Officer type","example":"P.Physique","nullable":true},"firstname":{"type":"string","description":"Officer firstname","example":"Jean","nullable":true},"lastname":{"type":"string","description":"Officer lastname","example":"Dupont","nullable":true},"fullNameTokenized":{"type":"string","description":"Tokenized full name","example":"jean dupont","nullable":true},"internalOfficerGroupId":{"type":"string","description":"Internal officer group ID","example":"683e239d36eebd0d0b558d69","nullable":true},"internalOfficerId":{"type":"string","description":"Internal officer ID","example":"6474e08e9a3c3bff25a1d6b2","nullable":true}}},"OfficerGetResponseDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique officer identifier","example":"6474e08e9a3c3bff25a1d6b2","nullable":true},"mainCompany":{"nullable":true,"description":"Main company mandate","type":"object","allOf":[{"$ref":"#/components/schemas/CompanyMandateDto"}]},"mainComandatory":{"nullable":true,"description":"Main comandatory information","type":"object","allOf":[{"$ref":"#/components/schemas/MainComandatoryDto"}]},"internalOfficerId":{"type":"string","description":"Internal officer ID","example":"66aa17d25da7ac2c4b089c36","nullable":true},"birthDate":{"type":"string","description":"Birth date","example":"1970-11","nullable":true},"birthDateFormatted":{"type":"string","description":"Formatted birth date","example":"1970-11-01T00:00:00.000Z","nullable":true},"dataCanBeDisplayed":{"type":"boolean","nullable":true,"description":"Data can be displayed","example":true},"firstname":{"type":"string","description":"Officer firstname","example":"Jean","nullable":true},"firstnameTokenized":{"type":"string","description":"Tokenized firstname","example":"jean","nullable":true},"fullNameTokenized":{"type":"string","description":"Tokenized full name","example":"jean dupont","nullable":true},"internalOfficerGroupId":{"type":"string","description":"Internal officer group ID","example":"66aa17d25da7ac2c4b089c36","nullable":true},"lastname":{"type":"string","description":"Officer lastname","example":"Dupont","nullable":true},"lastnameTokenized":{"type":"string","description":"Tokenized lastname","example":"dupont","nullable":true},"mandates":{"description":"List of mandates","nullable":true,"type":"array","items":{"$ref":"#/components/schemas/MandateDto"}},"type":{"type":"string","description":"Type","example":"P.Physique","nullable":true}}},"PatentsDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN company identifier (9 digits)","example":"552081317","nullable":true},"id":{"type":"string","description":"Unique patent identifier","example":"6474e08e9a3c3bff25a1d6b2","nullable":true},"date_granted":{"format":"date-time","type":"string","nullable":true,"description":"Date Granted","example":"2025-05-31T00:00:00.000Z"},"date_searched_completed":{"format":"date-time","type":"string","nullable":true,"description":"Date Searched Completed","example":"2025-05-31T00:00:00.000Z"},"title":{"type":"string","description":"Patent Title","example":"DETECTION DE DEFAUT ELECTRIQUE DANS UNE GENERATRICE","nullable":true},"type":{"type":"string","description":"Patent type","example":"B1","nullable":true},"applicants":{"description":"Applicants","example":["ELECTRICITE DE FRANCE","ELECTRICITE DE WINSCONSIN"],"type":"array","items":{"type":"string"}},"inventors":{"description":"Inventors","example":["JOHN DOE","JOHN SMITH"],"type":"array","items":{"type":"string"}},"agents":{"description":"Agents","example":["JOHN SMITH"],"type":"array","items":{"type":"string"}},"company_name":{"type":"string","description":"Company name","example":"ELECTRICITE DE FRANCE","nullable":true}}},"PatentsDtoPaginatedResponse":{"type":"object","properties":{"results":{"description":"List of results on the current page","type":"array","items":{"$ref":"#/components/schemas/PatentsDto"}},"pagination":{"description":"Pagination metadata","allOf":[{"$ref":"#/components/schemas/PaginationDto"}]}},"required":["results","pagination"]},"ProcedureCollectiveDto":{"type":"object","properties":{"id":{"type":"string","description":"Procedure collective ID","example":"68f1db6df9f6e4ab4f465fa5","nullable":true},"sirens":{"description":"SIREN numbers","example":["582110987"],"type":"array","items":{"type":"string"}},"date":{"format":"date-time","type":"string","nullable":true,"description":"Date","example":"2025-09-30T00:00:00.000Z"},"title":{"type":"string","description":"Procedure title","example":"Jugement ouverture liquidation judiciaire","nullable":true},"description":{"type":"string","description":"Procedure description","example":"Liquidation judiciaire","nullable":true},"announcement_number":{"type":"string","description":"Announcement number","example":"3103","nullable":true},"publication":{"type":"string","description":"Publication reference","example":"20250199","nullable":true},"related_announcement_number":{"type":"string","description":"Related announcement number","example":"4444","nullable":true},"related_publication":{"type":"string","description":"Related publication reference","example":"20240199","nullable":true},"external_id":{"type":"string","description":"External identifier","example":"A202001883348","nullable":true}}},"ProcedureCollectiveDtoPaginatedResponse":{"type":"object","properties":{"results":{"description":"List of results on the current page","type":"array","items":{"$ref":"#/components/schemas/ProcedureCollectiveDto"}},"pagination":{"description":"Pagination metadata","allOf":[{"$ref":"#/components/schemas/PaginationDto"}]}},"required":["results","pagination"]},"StatutesDto":{"type":"object","properties":{"siren":{"type":"string","description":"SIREN company identifier (9 digits)","example":"552081317","nullable":true},"id":{"type":"string","description":"Unique identifier","example":"6474e08e9a3c3bff25a1d6b2","nullable":true},"created_at":{"format":"date-time","type":"string","nullable":true,"description":"Creation date","example":"2026-01-15T10:30:00.000Z"},"downloadable":{"type":"boolean","nullable":true,"description":"Document is available for download","example":true},"decisions":{"description":"List of decisions","example":[],"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ActDecisionDto"}}}},"StatutesDtoPaginatedResponse":{"type":"object","properties":{"results":{"description":"List of results on the current page","type":"array","items":{"$ref":"#/components/schemas/StatutesDto"}},"pagination":{"description":"Pagination metadata","allOf":[{"$ref":"#/components/schemas/PaginationDto"}]}},"required":["results","pagination"]},"ExternalUserBalanceResponseDto":{"type":"object","properties":{"balance":{"type":"number","nullable":true,"example":85,"description":"User current balance"}},"required":["balance"]},"PdfBasicTypeEnum":{"type":"string","enum":["quotation","company-page","solvency","company-extract","contact","vat","eori","financial-outstanding","rne","sirene-situation"]},"PdfTypeWithIdRequirementEnum":{"type":"string","enum":["act","balance-sheet","bodacc","brand","collective-agreement","patent","procedure-collective","statute"]},"OfficeDocEnum":{"type":"string","enum":["company-agreement"]}}}}