Skip to main content
POST
/
v2
/
companies
/
search
/
indexed
Search Companies (indexed)
curl --request POST \
  --url https://api.kausate.com/v2/companies/search/indexed \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "jurisdictionCode": "de",
  "name": "<string>",
  "advancedQuery": {
    "jurisdiction": "de",
    "name": "BMW AG"
  },
  "limit": 10,
  "page": 0,
  "includeAlternativeNames": false,
  "includeSimilarNames": false
}
'
{
  "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>"
          }
        }
      ]
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "hasMore": true
  }
}

Authorizations

X-API-Key
string
header
required

Sign up at Kausate.com to get an API key

Headers

X-Partner-Customer-Id
string | null

Optional partner customer ID

Body

application/json

Request model for company search.

jurisdictionCode
string
default:de

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

name
string | null

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

Minimum string length: 1
advancedQuery
GermanAdvancedQuery · object

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

  • GermanAdvancedQuery
  • UKAdvancedQuery
Example:
{ "jurisdiction": "de", "name": "BMW AG" }
limit
integer | null
default:10
Required range: 1 <= x <= 1000
page
integer | null
default:0

Page number (0-based)

Required range: x >= 0
includeAlternativeNames
boolean
default:false

If true, searches alternative company names (more expensive). Default: false for optimal performance.

includeSimilarNames
boolean
default:false

If true, falls back to trigram similarity search when no exact matches found (more expensive). Default: false for optimal performance.

Response

Successful company search

Response model for company search.

searchResults
CompanySearchResult · object[]
required
pagination
Pagination · object
required

Pagination information for search results.