v1

latestSwagger 2.02026-07-17114752.0 KB

universal search: provides best company and person matches for given input query

get/search/v1/universal

Query parameters

querystring required

the query string

domainstring

set to "company" for companies only, "person" for persons only, otherwise leave empty

posstring

if additional results shall be downloaded, set this to the value of the nextPos attribute of the previous response

censorboolean

should be set when presenting the content on a public website

offsetinteger

offset of first item to return

limitinteger

maximum number of items to return

output'json' | 'xml'

response format

countriesstring

list of country ISO codes to restrict result set (empty to retrieve all countries). Valid values can be retrieved dynamically from the /reference/v1/overview endpoint.

statusstring

list of valid statuses (active, terminated, liquidation). Valid values can be retrieved dynamically from the /reference/v1/overview endpoint.

historyboolean

true to include historical data

financialsboolean

true to include financial data

eventsboolean

true to include event data

{"stackTrail":"components:parameters:eventType:schema:items","oasType":"schema","type":"unknown"}

restrict which event types will be returned if events equals true

maxEventsinteger

maximum number of events to return

relationsboolean

true to include related company and person data. Note: For owners, only majority shareholders are included. For more owners, use the "owners" parameter instead.

ownersboolean

true to include all owners/shareholders (companies & persons) of the subject company

ownershipsboolean

true to include companies owned by the subject company.

representativesboolean

true to include legal representatives of the subject company (e.g., managing directors, board members).

alwaysResolveboolean

true to lookup current state of related company from database

sheetsboolean

true to include company financial sheets (balance, earnings)

extrasboolean

true to include extra company data provided by 3rd parties

Response

A successful response

censoredboolean

true if results have been omitted because of censoring

offsetinteger

offset of result array in all results

nextOffsetinteger

offset to retrieve next batch of results

nextPosstring

position to retrieve next batch of results

totalinteger

total number of results (usually, this number is not available, unfortunately)