/ares/companies/vr

POST /api/ares/companies/vr

Price: 5 credits

Get Czech company public-register (OR) record: officers, shareholders, share capital, scope

How to use it

Get a Czech company's public register record by ICO: statutory and supervisory body members, shareholders, shares, share capital, signing rules and business scope.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• ico string required — Czech company identification number (ICO). Up to 8 digits; a leading 'CZ' is accepted. (examples: "27074358")

Response

• @type string (default: "AresVrCompany")
• ico string required
• name string nullable
• legal_form string nullable
• file_number string nullable
• registered_at string nullable
• updated_at string nullable
• status string nullable
• signing_rules string nullable
• share_capital object nullable
  • @type string (default: "AresShareCapital")
  • amount string nullable
  • currency string nullable
  • paid_up string nullable
• shares array
  • @type string (default: "AresShare")
  • type string nullable
  • form string nullable
  • kind string nullable
  • count integer nullable
  • nominal_value string nullable
  • currency string nullable
• statutory_members array
  • @type string (default: "AresVrMember")
  • role string nullable
  • function string nullable
  • first_name string nullable
  • last_name string nullable
  • company_name string nullable
  • ico string nullable
  • birth_date string nullable
  • citizenship string nullable
  • membership_start string nullable
  • membership_end string nullable
  • address object nullable
    • @type string (default: "AresAddress")
    • text string nullable
    • street string nullable
    • house_number integer nullable
    • orientation_number integer nullable
    • orientation_number_letter string nullable
    • city string nullable
    • city_part string nullable
    • district string nullable
    • region string nullable
    • postal_code integer nullable
    • country string nullable
    • country_code string nullable
• supervisory_members array
  • @type string (default: "AresVrMember")
  • role string nullable
  • function string nullable
  • first_name string nullable
  • last_name string nullable
  • company_name string nullable
  • ico string nullable
  • birth_date string nullable
  • citizenship string nullable
  • membership_start string nullable
  • membership_end string nullable
  • address object nullable
    • @type string (default: "AresAddress")
    • text string nullable
    • street string nullable
    • house_number integer nullable
    • orientation_number integer nullable
    • orientation_number_letter string nullable
    • city string nullable
    • city_part string nullable
    • district string nullable
    • region string nullable
    • postal_code integer nullable
    • country string nullable
    • country_code string nullable
• shareholders array
  • @type string (default: "AresVrMember")
  • role string nullable
  • function string nullable
  • first_name string nullable
  • last_name string nullable
  • company_name string nullable
  • ico string nullable
  • birth_date string nullable
  • citizenship string nullable
  • membership_start string nullable
  • membership_end string nullable
  • address object nullable
    • @type string (default: "AresAddress")
    • text string nullable
    • street string nullable
    • house_number integer nullable
    • orientation_number integer nullable
    • orientation_number_letter string nullable
    • city string nullable
    • city_part string nullable
    • district string nullable
    • region string nullable
    • postal_code integer nullable
    • country string nullable
    • country_code string nullable
• business_scope array

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 Czech company found for the given ICO in the public 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.