Search Companies (real-time)

curl --request POST \
  --url https://api.kausate.com/v2/companies/search/live \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "companyName": "<string>",
  "advancedQuery": {
    "jurisdiction": "de",
    "name": "BMW AG"
  },
  "jurisdictionCode": "de",
  "customerReference": "<string>"
}
'

{
  "searchResults": [
    {
      "kausateId": "<string>",
      "jurisdictionCode": "<string>",
      "name": "<string>",
      "alternativeNames": [
        "<string>"
      ],
      "identifiers": [
        {
          "value": "<string>",
          "type": "<string>",
          "source": "<string>",
          "description": "<string>",
          "extra": {}
        }
      ],
      "addresses": [
        {
          "type": "arrival",
          "source": "<string>",
          "original": "<string>",
          "normalized": {
            "house": "<string>",
            "category": "<string>",
            "near": "<string>",
            "houseNumber": "<string>",
            "road": "<string>",
            "unit": "<string>",
            "level": "<string>",
            "staircase": "<string>",
            "entrance": "<string>",
            "poBox": "<string>",
            "postcode": "<string>",
            "suburb": "<string>",
            "cityDistrict": "<string>",
            "city": "<string>",
            "island": "<string>",
            "stateDistrict": "<string>",
            "state": "<string>",
            "county": "<string>",
            "countryRegion": "<string>",
            "country": "<string>",
            "countryCode": "<string>",
            "worldRegion": "<string>"
          }
        }
      ]
    }
  ],
  "type": "liveSearch"
}

POST

companies

live

Search Companies (real-time)

curl --request POST \
  --url https://api.kausate.com/v2/companies/search/live \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "companyName": "<string>",
  "advancedQuery": {
    "jurisdiction": "de",
    "name": "BMW AG"
  },
  "jurisdictionCode": "de",
  "customerReference": "<string>"
}
'

{
  "searchResults": [
    {
      "kausateId": "<string>",
      "jurisdictionCode": "<string>",
      "name": "<string>",
      "alternativeNames": [
        "<string>"
      ],
      "identifiers": [
        {
          "value": "<string>",
          "type": "<string>",
          "source": "<string>",
          "description": "<string>",
          "extra": {}
        }
      ],
      "addresses": [
        {
          "type": "arrival",
          "source": "<string>",
          "original": "<string>",
          "normalized": {
            "house": "<string>",
            "category": "<string>",
            "near": "<string>",
            "houseNumber": "<string>",
            "road": "<string>",
            "unit": "<string>",
            "level": "<string>",
            "staircase": "<string>",
            "entrance": "<string>",
            "poBox": "<string>",
            "postcode": "<string>",
            "suburb": "<string>",
            "cityDistrict": "<string>",
            "city": "<string>",
            "island": "<string>",
            "stateDistrict": "<string>",
            "state": "<string>",
            "county": "<string>",
            "countryRegion": "<string>",
            "country": "<string>",
            "countryCode": "<string>",
            "worldRegion": "<string>"
          }
        }
      ]
    }
  ],
  "type": "liveSearch"
}

Authorizations

X-API-Key

string

header

required

Headers

X-Partner-Customer-Id

string | null

Optional partner customer ID

Query Parameters

sync

boolean

default:true

If True, wait for results. If False, return workflow ID immediately

Body

application/json

Request model for live company search using BatchIndexCrawl.

companyName

string | null

Company name to search for. Either 'companyName' or 'advancedQuery' must be provided.

Minimum string length: 1

advancedQuery

GermanAdvancedQuery · object

Advanced search using local identifier components. Either 'companyName' or 'advancedQuery' must be provided.

GermanAdvancedQuery
UKAdvancedQuery

Show child attributes

advancedQuery.jurisdiction

string

default:de

Jurisdiction discriminator (automatically inferred from jurisdictionCode at API level)

Allowed value: "de"

advancedQuery.name

string | null

Company name to search for. Can be used alone or combined with identifier fields for more specific searches. Empty string treated as None.

advancedQuery.courtId

string | null

Court ID (e.g., 'D2803', 'D2601'). Cannot be used with courtCity. Empty string treated as None.

advancedQuery.courtCity

string | null

Court city name (e.g., 'München', 'Berlin'). Will be fuzzy-matched and converted to courtId. Cannot be used with courtId. Empty string treated as None.

advancedQuery.registerType

string | null

Register type (e.g., 'HRB', 'HRA', 'GNR', 'PR', 'VR'). Case-insensitive - will be normalized to uppercase. Empty string treated as None.

advancedQuery.registerNumber

Register number (e.g., '10364B', '10364', 10364, 'HRB 275800', or 'HR B 275800'). Can include register type prefix (HRB, HRA, HR B, HR A, G NR, etc.) which will be automatically extracted and used if registerType is not explicitly provided. Supports both spaced (HR B) and non-spaced (HRB) variants. If string contains suffix, it will be extracted.

advancedQuery.registerSuffix

string | null

Register suffix (e.g., 'B', 'BHV'). Can be provided explicitly or extracted from registerNumber. Case-insensitive - will be normalized to uppercase. Empty string treated as None.

Example:

{ "jurisdiction": "de", "name": "BMW AG" }

jurisdictionCode

string

default:de

ISO 3166-1 alpha-2 country code (e.g., 'de' for Germany, 'uk' for United Kingdom)

customerReference

string | null

Optional customer reference for tracking

Maximum string length: 150

Response

Live search completed successfully

LiveSearchResponse
ProductOrderResponse

Response model for live company search (same as CompanySearchResponse but without pagination).

searchResults

CompanySearchResult · object[]

required

Show child attributes

searchResults.kausateId

string

required

searchResults.jurisdictionCode

string

required

ISO 3166-1 alpha-2 country code

searchResults.name

string

required

searchResults.alternativeNames

string[] | null

All alternative names (former names) for this company from the index

searchResults.identifiers

Identifier · object[] | null

Company identifiers (e.g., HR number for German companies)

Show child attributes

searchResults.identifiers.value

string

required

The text/number value of the identifier

searchResults.identifiers.type

string

required

The type must include the jurisdiction in which it is issued

searchResults.identifiers.source

string | null

The source of this identifier (e.g., 'registrar', 'company', 'third_party')

searchResults.identifiers.description

string | null

Free-text description of the identifier when type is unknown or needs clarification

searchResults.identifiers.extra

Extra · object

Additional metadata about the identifier

searchResults.addresses

Address · object[] | null

Company addresses (registered office, business addresses, etc.)

Show child attributes

searchResults.addresses.type

enum<string> | null

Address type definitions with descriptions

Available options:

arrival,

business,

departure,

mailing,

operations,

physical,

placeOfBirth,

receiverAddress,

registered,

residential,

shipperAddress,

transit

searchResults.addresses.source

string | null

searchResults.addresses.original

string | null

searchResults.addresses.normalized

NormalizedAddress · object

Normalized address fields with null values excluded from serialization.

Show child attributes

searchResults.addresses.normalized.house

string | null

searchResults.addresses.normalized.category

string | null

searchResults.addresses.normalized.near

string | null

searchResults.addresses.normalized.houseNumber

string | null

searchResults.addresses.normalized.road

string | null

searchResults.addresses.normalized.unit

string | null

searchResults.addresses.normalized.level

string | null

searchResults.addresses.normalized.staircase

string | null

searchResults.addresses.normalized.entrance

string | null

searchResults.addresses.normalized.poBox

string | null

searchResults.addresses.normalized.postcode

string | null

searchResults.addresses.normalized.suburb

string | null

searchResults.addresses.normalized.cityDistrict

string | null

searchResults.addresses.normalized.city

string | null

searchResults.addresses.normalized.island

string | null

searchResults.addresses.normalized.stateDistrict

string | null

searchResults.addresses.normalized.state

string | null

searchResults.addresses.normalized.county

string | null

searchResults.addresses.normalized.countryRegion

string | null

searchResults.addresses.normalized.country

string | null

searchResults.addresses.normalized.countryCode

string | null

searchResults.addresses.normalized.worldRegion

string | null

type

string

default:liveSearch

Allowed value: "liveSearch"

Search Companies (indexed)Retrieve Company Document (real-time)

⌘I

Getting Started

Integration

API Reference

Search Companies (real-time)

Authorizations

Headers

Query Parameters

Body

Response