{"openapi":"3.1.0","info":{"title":"Belgian Company Data API","description":"Company data from the Belgian Crossroads Bank for Enterprises (BCE/KBO).","version":"1.0.0"},"paths":{"/api/v1/companies/{enterprise_number}":{"get":{"summary":"Get Company","operationId":"get_company_api_v1_companies__enterprise_number__get","parameters":[{"name":"enterprise_number","in":"path","required":true,"schema":{"type":"string","title":"Enterprise Number"}},{"name":"lang","in":"query","required":false,"schema":{"type":"string","default":"NL","title":"Lang"}},{"name":"establishments","in":"query","required":false,"schema":{"type":"string","title":"Establishments"}},{"name":"vies","in":"query","required":false,"schema":{"type":"string","title":"Vies"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/companies/{enterprise_number}/history":{"get":{"summary":"Company History","operationId":"company_history_api_v1_companies__enterprise_number__history_get","parameters":[{"name":"enterprise_number","in":"path","required":true,"schema":{"type":"string","title":"Enterprise Number"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/companies/{enterprise_number}/accounts":{"get":{"summary":"Company Accounts","operationId":"company_accounts_api_v1_companies__enterprise_number__accounts_get","parameters":[{"name":"enterprise_number","in":"path","required":true,"schema":{"type":"string","title":"Enterprise Number"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Limit"}},{"name":"refresh","in":"query","required":false,"schema":{"type":"string","title":"Refresh"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/companies/{enterprise_number}/benchmark":{"get":{"summary":"Company Benchmark","operationId":"company_benchmark_api_v1_companies__enterprise_number__benchmark_get","parameters":[{"name":"enterprise_number","in":"path","required":true,"schema":{"type":"string","title":"Enterprise Number"}},{"name":"depth","in":"query","required":false,"schema":{"type":"integer","default":2,"title":"Depth"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/companies/{enterprise_number}/group":{"get":{"summary":"Company Group","operationId":"company_group_api_v1_companies__enterprise_number__group_get","parameters":[{"name":"enterprise_number","in":"path","required":true,"schema":{"type":"string","title":"Enterprise Number"}},{"name":"depth","in":"query","required":false,"schema":{"type":"integer","default":2,"title":"Depth"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/watchlist":{"get":{"summary":"List Watchlist","operationId":"list_watchlist_api_v1_watchlist_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"summary":"Add To Watchlist","operationId":"add_to_watchlist_api_v1_watchlist_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/watchlist/{enterprise_number}":{"delete":{"summary":"Remove From Watchlist","operationId":"remove_from_watchlist_api_v1_watchlist__enterprise_number__delete","parameters":[{"name":"enterprise_number","in":"path","required":true,"schema":{"type":"string","title":"Enterprise Number"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/webhook":{"put":{"summary":"Set Webhook","operationId":"set_webhook_api_v1_webhook_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/people/{person_id}/network":{"get":{"summary":"Person Network","operationId":"person_network_api_v1_people__person_id__network_get","parameters":[{"name":"person_id","in":"path","required":true,"schema":{"type":"integer","title":"Person Id"}},{"name":"depth","in":"query","required":false,"schema":{"type":"integer","default":2,"title":"Depth"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/people/{person_id}/mandates":{"get":{"summary":"Person Mandates","operationId":"person_mandates_api_v1_people__person_id__mandates_get","parameters":[{"name":"person_id","in":"path","required":true,"schema":{"type":"integer","title":"Person Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/companies":{"get":{"summary":"Search Companies","operationId":"search_companies_api_v1_companies_get","parameters":[{"name":"name","in":"query","required":false,"schema":{"type":"string","title":"Name"}},{"name":"nace","in":"query","required":false,"schema":{"type":"string","title":"Nace"}},{"name":"city","in":"query","required":false,"schema":{"type":"string","title":"City"}},{"name":"zip","in":"query","required":false,"schema":{"type":"string","title":"Zip"}},{"name":"legal_form","in":"query","required":false,"schema":{"type":"string","title":"Legal Form"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","title":"Status"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":20,"title":"Limit"}},{"name":"lang","in":"query","required":false,"schema":{"type":"string","default":"NL","title":"Lang"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/autocomplete":{"get":{"summary":"Autocomplete","operationId":"autocomplete_api_v1_autocomplete_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string","title":"Q"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/changes":{"get":{"summary":"Recent Changes","operationId":"recent_changes_api_v1_changes_get","parameters":[{"name":"since","in":"query","required":false,"schema":{"type":"string","title":"Since"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}},{"name":"lang","in":"query","required":false,"schema":{"type":"string","default":"NL","title":"Lang"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/company-data/login":{"post":{"summary":"Login","operationId":"login_company_data_login_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/company-data/logout":{"get":{"summary":"Logout","operationId":"logout_company_data_logout_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/company-data":{"get":{"summary":"Landing","operationId":"landing_company_data_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/":{"get":{"summary":"Landing","operationId":"landing__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/company-data/docs":{"get":{"summary":"Docs","operationId":"docs_company_data_docs_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/company-data/search":{"get":{"summary":"Search","operationId":"search_company_data_search_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string","title":"Q"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/company-data/company/{enterprise_number}":{"get":{"summary":"Company Public","operationId":"company_public_company_data_company__enterprise_number__get","parameters":[{"name":"enterprise_number","in":"path","required":true,"schema":{"type":"string","title":"Enterprise Number"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/company-data/sector/{nace}":{"get":{"summary":"Sector Page","operationId":"sector_page_company_data_sector__nace__get","parameters":[{"name":"nace","in":"path","required":true,"schema":{"type":"string","title":"Nace"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/company-data/city/{city}":{"get":{"summary":"City Page","operationId":"city_page_company_data_city__city__get","parameters":[{"name":"city","in":"path","required":true,"schema":{"type":"string","title":"City"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/company-data/sector/{nace}/{city}":{"get":{"summary":"Sector City Page","operationId":"sector_city_page_company_data_sector__nace___city__get","parameters":[{"name":"nace","in":"path","required":true,"schema":{"type":"string","title":"Nace"}},{"name":"city","in":"path","required":true,"schema":{"type":"string","title":"City"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/company-data/legal/terms":{"get":{"summary":"Terms","operationId":"terms_company_data_legal_terms_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/company-data/legal/privacy":{"get":{"summary":"Privacy","operationId":"privacy_company_data_legal_privacy_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/company-data/legal/mentions-legales":{"get":{"summary":"Legal Notice","operationId":"legal_notice_company_data_legal_mentions_legales_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/health":{"get":{"summary":"Health","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/postman.json":{"get":{"summary":"Postman Collection","operationId":"postman_collection_api_postman_json_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WatchRequest":{"properties":{"enterprise_number":{"type":"string","title":"Enterprise Number"}},"type":"object","required":["enterprise_number"],"title":"WatchRequest"},"WebhookRequest":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},"type":"object","title":"WebhookRequest"}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key"}}}}