Retrieve Document (real-time)
Retrieve Company Document (sync)
Retrieve a company document synchronously. Blocks for up to 300 seconds.
The async POST /v2/companies/documents endpoint
is the preferred method. Government registries frequently time out — async
with webhooks or polling handles those failures gracefully.
Authorization
api_key X-API-Key<token>
Sign up at Kausate.com to get an API key
In: header
Query Parameters
batch?boolean
Mark as a batch/backfill request. Batch requests run at lowest priority to avoid blocking interactive queries.
Default
falseHeader Parameters
Kausate-Version?string
Default
"2026-05-01"Format
dateX-Customer-Id?|
Optional customer ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.kausate.com/v2/companies/documents/sync" \ -H "Kausate-Version: 2026-05-01" \ -H "Content-Type: application/json" \ -d '{ "kausateId": "string" }'{
"orderId": "order-co_de_4JFFrsbQ99t1nmRw2JgzmG-DEHRAD-20240319143022",
"customerReference": "doc-order-123",
"status": "completed",
"requestTime": "2024-03-19T14:30:22.787045Z",
"responseTime": "2024-03-19T14:31:05.108791Z",
"result": {
"downloadLink": "https://www.kausate.com/downloads/2024-03-19T14-31-05+0000_DEHRAD_Example_Solutions.pdf"
}
}{
"detail": "Invalid company ID format"
}{
"detail": "Invalid API key"
}{
"detail": "Insufficient credits. Required: 10, Available: 5"
}{
"detail": "Company not found"
}{
"detail": "Request timed out after 300 seconds. The workflow has been cancelled."
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"detail": "An internal error occurred"
}Last updated on