Get Live Search Run
Retrieve typed status for a live-search run.
Authorization
api_key Sign up at Kausate.com to get an API key
In: header
Path Parameters
Live search run ID
Query Parameters
Optional customer partner ID for validation
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.kausate.com/v2/companies/search/runs/string"{
"orderId": "string",
"customerReference": "string",
"partnerCustomerId": "string",
"status": "running",
"requestTime": "2019-08-24T14:15:22Z",
"responseTime": "2019-08-24T14:15:22Z",
"result": {
"type": "liveSearch",
"searchResults": [
{
"kausateId": "string",
"jurisdictionCode": "aa",
"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"
},
"coordinate": {
"latitude": -90,
"longitude": -180
}
}
]
}
]
},
"error": "string",
"currentActivity": "string"
}{
"detail": "Invalid company ID format"
}{
"detail": "Invalid API key"
}{
"detail": "Order not found"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}{
"detail": "An internal error occurred"
}Last updated on
Search Companies (real-time)POST
Search for companies in real-time from official business registries. Returns results with Kausate IDs. **Synchronous mode** (default, `sync=true`): Waits for results and returns an `ExecutionResponse` with the search results directly. **Asynchronous mode** (`sync=false`): Returns immediately with an `orderId`. Results are delivered via webhook (if configured) as an `ExecutionResponse` containing a `LiveSearchResult` with the `searchResults` array. The webhook payload includes a top-level `orderId` for correlation; callers can also pass `customerReference` in the request body for additional correlation. You can also poll for results using GET /v2/companies/search/runs/{orderId}.
Prefill Company DataPOST
Get company report data for form prefilling (indexed with real-time fallback).