KausateKausate Docs
Api reference2025 04 01Documents
Viewing API version 2025-04-01. View the latest version.

Retrieve Company Document

Retrieve a company document from official registries.

POST
/v2/companies/{kausateId}/documents

Authorization

api_key
X-API-Key<token>

Sign up at Kausate.com to get an API key

In: header

Path Parameters

kausateId*string

Company ID

Query Parameters

sync?boolean

Return result synchronously with 300s timeout. Not recommended: government registries are unreliable and timeouts are common. Use default async mode with webhooks (recommended) or polling using the orderId instead.

Defaultfalse
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"2025-04-01"
Formatdate
X-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/string/documents" \  -H "Kausate-Version: 2025-04-01" \  -H "Content-Type: application/json" \  -d '{}'

{
  "orderId": "order-co_de_4JFFrsbQ99t1nmRw2JgzmG-DEHRAD-20240319143022",
  "customerReference": "doc-order-123",
  "customerId": "partner-berlin-001"
}

{
  "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