Skip to main content
POST
/
api
/
prh
/
companies
/prh/companies
curl --request POST \
  --url https://api.anysite.io/api/prh/companies \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "business_id": "<string>",
  "timeout": 300
}
'
[
  {
    "@type": "@prh_company",
    "business_id": {
      "@type": "@prh_business_id",
      "value": "<string>",
      "registration_date": "<string>",
      "source": "<string>"
    },
    "eu_id": {
      "@type": "@prh_eu_id",
      "value": "<string>",
      "source": "<string>"
    },
    "names": [],
    "main_business_line": {
      "@type": "@prh_main_business_line",
      "type": "<string>",
      "type_code_set": "<string>",
      "descriptions": []
    },
    "website": {
      "@type": "@prh_website",
      "url": "<string>",
      "registration_date": "<string>",
      "source": "<string>"
    },
    "company_forms": [],
    "company_situations": [],
    "registered_entries": [],
    "addresses": [],
    "public_notices": [],
    "trade_register_status": "<string>",
    "status": "<string>",
    "registration_date": "<string>",
    "last_modified": "<string>"
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
business_id
string
required

Finnish Business ID (Y-tunnus), format NNNNNNN-N

Example:

"0112038-9"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

@type
string
default:@prh_company
business_id
PrhBusinessId · object
eu_id
PrhEuId · object
names
PrhName · object[]
main_business_line
PrhMainBusinessLine · object
website
PrhWebsite · object
company_forms
PrhCompanyFormItem · object[]
company_situations
PrhCompanySituation · object[]
registered_entries
PrhRegisteredEntry · object[]
addresses
PrhAddress · object[]
public_notices
PrhPublicNotice · object[]
trade_register_status
string | null
status
string | null
registration_date
string | null
last_modified
string | null