/prh/companies

POST /api/prh/companies

Price: 1 credit

Get Finnish company details by Business ID (Y-tunnus)

How to use it

Get full registry details for a Finnish company by its Business ID (Y-tunnus, format NNNNNNN-N). Returns names, business line, addresses, company forms, registration status and registered entries.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• business_id string required — Finnish Business ID (Y-tunnus), format NNNNNNN-N (examples: "0112038-9")

Response

• @type string (default: "PrhCompany")
• business_id object nullable
  • @type string (default: "PrhBusinessId")
  • value string nullable
  • registration_date string nullable
  • source string nullable
• eu_id object nullable
  • @type string (default: "PrhEuId")
  • value string nullable
  • source string nullable
• names array (default: [])
  • @type string (default: "PrhName")
  • name string nullable
  • type string nullable
  • registration_date string nullable
  • end_date string nullable
  • version integer nullable
  • source string nullable
• main_business_line object nullable
  • @type string (default: "PrhMainBusinessLine")
  • type string nullable
  • type_code_set string nullable
  • descriptions array (default: [])
    • @type string (default: "PrhLocalizedText")
    • language_code string nullable
    • description string nullable
• website object nullable
  • @type string (default: "PrhWebsite")
  • url string nullable
  • registration_date string nullable
  • source string nullable
• company_forms array (default: [])
  • @type string (default: "PrhCompanyFormItem")
  • type string nullable
  • descriptions array (default: [])
    • @type string (default: "PrhLocalizedText")
    • language_code string nullable
    • description string nullable
  • registration_date string nullable
  • end_date string nullable
  • version integer nullable
  • source string nullable
• company_situations array (default: [])
  • @type string (default: "PrhCompanySituation")
  • type string nullable
  • descriptions array (default: [])
    • @type string (default: "PrhLocalizedText")
    • language_code string nullable
    • description string nullable
  • registration_date string nullable
  • source string nullable
• registered_entries array (default: [])
  • @type string (default: "PrhRegisteredEntry")
  • type string nullable
  • descriptions array (default: [])
    • @type string (default: "PrhLocalizedText")
    • language_code string nullable
    • description string nullable
  • status string nullable
  • register_code string nullable
  • authority string nullable
  • registration_date string nullable
  • end_date string nullable
• addresses array (default: [])
  • @type string (default: "PrhAddress")
  • type integer nullable
  • street string nullable
  • building_number string nullable
  • entrance string nullable
  • apartment_number string nullable
  • apartment_id_suffix string nullable
  • post_code string nullable
  • post_office_box string nullable
  • post_offices array (default: [])
    • @type string (default: "PrhPostOffice")
    • city string nullable
    • language_code string nullable
    • municipality_code string nullable
  • co string nullable
  • free_address_line string nullable
  • country string nullable
  • registration_date string nullable
  • source string nullable
• public_notices array (default: [])
  • @type string (default: "PrhPublicNotice")
  • registration_date string nullable
  • record_number string nullable
  • type_of_registration string nullable
  • entry_codes array (default: [])
• trade_register_status string nullable
• status string nullable
• registration_date string nullable
• last_modified 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 — Business ID not found in the Finnish company 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.