/kbo/companies/search

POST /api/kbo/companies/search

Price: 1 credit

Search Belgian companies and establishment units in the Crossroads Bank for Enterprises (CBE/KBO/BCE) by name (phonetic by default, or exact), optionally filtered by legal form, postal code, municipality, person type and active status. Returns each match's enterprise number, name, entity type, status and address.

How to use it

Search Belgian companies by name (e.g. 'proximus'). Optionally pass exact, legal_form, postal_code, city, include_old_names, natural_person, legal_person, establishment_unit or only_active to narrow results. Returns enterprise_number, name, entity_kind, status and address for each match. Feed enterprise_number into kbo/companies for the full registry record.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Company or person name to match (examples: "proximus"; minLength: 1)
• count integer required — Max number of results to return (min: 1)
• exact boolean — Match the name exactly instead of phonetically (default: false)
• legal_form string nullable — Restrict results to a single legal form (one of: "070", "721", "706", "008", "006", "ABO", "011", "612", "017", "012", "610", "015", "014", "OVE")
• postal_code string nullable — Restrict results to a postal code (examples: "1030")
• city string nullable — Restrict results to a municipality (examples: "Schaerbeek")
• include_old_names boolean — Also match former (historical) names (default: false)
• natural_person boolean — Include entities registered as natural persons (default: true)
• legal_person boolean — Include entities registered as legal persons (default: true)
• establishment_unit boolean — Also match establishment units by name (default: true)
• only_active boolean — Return only active entities (default: false)

Response

• @type string (default: "KboCompanySearchItem")
• enterprise_number string required
• name string nullable
• entity_kind string nullable
• status string nullable
• address string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.