Skip to main content
POST
/
api
/
zefix
/
companies
/zefix/companies
curl --request POST \
  --url https://api.anysite.io/api/zefix/companies \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "company": "<string>",
  "timeout": 300
}
'
[
  {
    "name": "<string>",
    "@type": "@zefix_company",
    "ehraid": 123,
    "uid": "<string>",
    "uid_formatted": "<string>",
    "chid": "<string>",
    "chid_formatted": "<string>",
    "legal_seat": "<string>",
    "legal_seat_id": 123,
    "register_office_id": 123,
    "legal_form_id": 123,
    "status": "<string>",
    "shab_date": "<string>",
    "delete_date": "<string>",
    "cantonal_excerpt_web": "<string>",
    "purpose": "<string>",
    "address": {
      "@type": "@zefix_address",
      "organisation": "<string>",
      "care_of": "<string>",
      "street": "<string>",
      "house_number": "<string>",
      "addon": "<string>",
      "po_box": "<string>",
      "town": "<string>",
      "swiss_zip_code": "<string>",
      "country": "<string>"
    },
    "translations": [
      "<string>"
    ],
    "old_names": [
      {
        "@type": "@zefix_old_name",
        "name": "<string>",
        "ehraid": 123
      }
    ],
    "audit_firms": [
      {
        "@type": "@zefix_audit_firm",
        "name": "<string>",
        "ehraid": 123,
        "uid": "<string>"
      }
    ],
    "main_offices": [
      {
        "@type": "@zefix_related_company",
        "name": "<string>",
        "ehraid": 123,
        "uid": "<string>",
        "legal_seat": "<string>"
      }
    ],
    "further_main_offices": [
      {
        "@type": "@zefix_related_company",
        "name": "<string>",
        "ehraid": 123,
        "uid": "<string>",
        "legal_seat": "<string>"
      }
    ],
    "branch_offices": [
      {
        "@type": "@zefix_related_company",
        "name": "<string>",
        "ehraid": 123,
        "uid": "<string>",
        "legal_seat": "<string>"
      }
    ],
    "has_taken_over": [
      {
        "@type": "@zefix_related_company",
        "name": "<string>",
        "ehraid": 123,
        "uid": "<string>",
        "legal_seat": "<string>"
      }
    ],
    "was_taken_over_by": [
      {
        "@type": "@zefix_related_company",
        "name": "<string>",
        "ehraid": 123,
        "uid": "<string>",
        "legal_seat": "<string>"
      }
    ]
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
company
string
required

Company EHRA ID (numeric) or Swiss UID (format CHE-NNN.NNN.NNN)

Examples:

"126286"

"CHE-105.909.036"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

name
string
required
@type
string
default:@zefix_company
ehraid
integer | null
uid
string | null
uid_formatted
string | null
chid
string | null
chid_formatted
string | null
register_office_id
integer | null
status
string | null
shab_date
string | null
delete_date
string | null
cantonal_excerpt_web
string | null
purpose
string | null
address
ZefixAddress · object
translations
string[]
old_names
ZefixOldName · object[]
audit_firms
ZefixAuditFirm · object[]
main_offices
ZefixRelatedCompany · object[]
further_main_offices
ZefixRelatedCompany · object[]
branch_offices
ZefixRelatedCompany · object[]
has_taken_over
ZefixRelatedCompany · object[]
was_taken_over_by
ZefixRelatedCompany · object[]