Search Companies (real-time)

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
GBAdvancedQuery

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, 'gb' for Great Britain)

customerReference

string | null

Optional customer reference for tracking

Maximum string length: 150

Response

Live search completed successfully

ProductOrderResponse
ExecutionResponse[LiveSearchResponse]

Response model for product order.

orderId

string

required

customerReference

string | null

Maximum string length: 150

partnerCustomerId

string | null

Maximum string length: 150

Getting Started

Integration

API Reference

Search Companies (real-time)

Authorizations

Headers

Query Parameters

Body

Response