/kbo/establishments

POST /api/kbo/establishments

Price: 1 credit

Get a Belgian establishment unit's record from the Crossroads Bank for Enterprises (CBE/KBO/BCE) by its establishment unit number: parent enterprise number, status, start date, all registered names (with language), address, contact details (phone, fax, email, web), NACE-BEL activities (all versions, main and additional) and authorisations.

How to use it

Look up one Belgian establishment unit (local branch) by its establishment unit number (e.g. '2.102.964.255', accepts '2102964255'). Returns one item with establishment_number, enterprise_number (the parent company), status, start_date, name, names, address, phone, fax, email, web, activities (NACE-BEL code, description, activity_type, version, is_main, since) and authorisations. To find establishment unit numbers for a company, use kbo/companies/establishments.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• establishment_number string required — Belgian establishment unit number (CBE/KBO/BCE) (examples: "2.102.964.255", "2102964255")

Response

• @type string (default: "KboEstablishment")
• establishment_number string required
• enterprise_number string nullable
• status string nullable
• entity_status string nullable
• start_date string nullable
• name string nullable
• names array (default: [])
  • @type string (default: "KboEstablishmentName")
  • name string required
  • language string nullable
  • since string nullable
• address string nullable
• address_since string nullable
• phone string nullable
• fax string nullable
• email string nullable
• web string nullable
• activities array (default: [])
  • @type string (default: "KboEstablishmentActivity")
  • code string required
  • description string nullable
  • activity_type string required
  • version string required
  • is_main boolean (default: false)
  • since string nullable
• authorisations array (default: [])
• url string required

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 — No establishment unit found for the given number 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.