/zefix/companies

POST /api/zefix/companies

Price: 1 credit

Get Swiss company details by EHRA ID or UID

How to use it

Get full registry details for a Swiss company by its EHRA ID (numeric) or UID (CHE-NNN.NNN.NNN). Returns name, legal seat, status, purpose, address, audit firms, related offices and previous names.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Company EHRA ID (numeric) or Swiss UID (format CHE-NNN.NNN.NNN) (examples: "126286", "CHE-105.909.036")

Response

• @type string (default: "ZefixCompany")
• ehraid integer nullable
• name string required
• uid string nullable
• uid_formatted string nullable
• chid string nullable
• chid_formatted string nullable
• legal_seat string nullable
• legal_seat_id integer nullable
• register_office_id integer nullable
• legal_form_id integer nullable
• status string nullable
• shab_date string nullable
• delete_date string nullable
• cantonal_excerpt_web string nullable
• purpose string nullable
• address object nullable
  • @type string (default: "ZefixAddress")
  • organisation string nullable
  • care_of string nullable
  • street string nullable
  • house_number string nullable
  • addon string nullable
  • po_box string nullable
  • town string nullable
  • swiss_zip_code string nullable
  • country string nullable
• translations array
• old_names array
  • @type string (default: "ZefixOldName")
  • name string nullable
  • ehraid integer nullable
• audit_firms array
  • @type string (default: "ZefixAuditFirm")
  • name string nullable
  • ehraid integer nullable
  • uid string nullable
• main_offices array
  • @type string (default: "ZefixRelatedCompany")
  • name string nullable
  • ehraid integer nullable
  • uid string nullable
  • legal_seat string nullable
• further_main_offices array
  • @type string (default: "ZefixRelatedCompany")
  • name string nullable
  • ehraid integer nullable
  • uid string nullable
  • legal_seat string nullable
• branch_offices array
  • @type string (default: "ZefixRelatedCompany")
  • name string nullable
  • ehraid integer nullable
  • uid string nullable
  • legal_seat string nullable
• has_taken_over array
  • @type string (default: "ZefixRelatedCompany")
  • name string nullable
  • ehraid integer nullable
  • uid string nullable
  • legal_seat string nullable
• was_taken_over_by array
  • @type string (default: "ZefixRelatedCompany")
  • name string nullable
  • ehraid integer nullable
  • uid string nullable
  • legal_seat 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 — Company not found in the Swiss commercial register 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.