Retrieve Company Report

Place an order for a structured company report. Poll GET /v2/companies/report/{orderId} or subscribe via webhook.

Query Parameters

batch?boolean

Mark as a batch/backfill request. Batch requests run at lowest priority to avoid blocking interactive queries.

Defaultfalse

Header Parameters

Kausate-Version?string

Default"2026-05-01"

Formatdate

X-Customer-Id?|

Optional customer ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

kausateId*string

Kausate universal company identifier (format: co_{jurisdiction}_{id})

Match^co_([a-z]{2}|[a-z]{2}-[a-z]{2})_[a-zA-Z0-9]+$

Length1 <= length

customerReference?|

metadata?|

Optional customer-supplied JSON metadata echoed back in order responses. Serialized JSON must be at most 4096 bytes.

bypassCache?boolean

If true, bypass daily deduplication and force a fresh request.

Defaultfalse

dataSections?array<>|

Sections to include in the report. Omit (or pass null) to receive the basic report only; list specific sections to request them explicitly. Use allAvailable to request every section available for the company jurisdiction.

Response Body

`application/json`

curl -X POST "https://api.staging.kausate.com/v2/companies/report" \  -H "Kausate-Version: 2026-05-01" \  -H "Content-Type: application/json" \  -d '{    "kausateId": "string"  }'

{
  "orderId": "report-4JFFrsbQ99t1nmRw2JgzmG-DEHRSI-20240319143022",
  "customerReference": "my-ref-123",
  "cachedOrder": false,
  "resultUrl": "/v2/companies/report/report-4JFFrsbQ99t1nmRw2JgzmG-DEHRSI-20240319143022"
}

{
  "detail": "Invalid company ID format"
}

{
  "detail": "Invalid API key"
}

{
  "detail": "Insufficient credits. Required: 10, Available: 5"
}

{
  "detail": "Company not found"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "detail": "An internal error occurred"
}

Retrieve Company Report

Authorization

Query Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`