KausateKausate Docs
List documents

List documents: order (async)

Place an order to list documents available for a company. Poll GET /v2/companies/documents/list/{orderId} or subscribe via webhook.

When to use it

List the documents the register holds for a company (annual accounts, articles, register extracts, filings) before you buy one. Each entry carries a kausateDocumentId to pass to document retrieval. The list is always fetched fresh: it is never served from an earlier order.

Example

curl -X POST https://api.kausate.com/v2/companies/documents/list \
  -H "X-API-Key: your_api_key" \
  -H "Kausate-Version: 2026-08-01" \
  -H "Content-Type: application/json" \
  -d '{"kausateId": "co_zz_4O3wnpE5u1K5AXnkARuhp"}'

The order response carries orderId and resultUrl. The completed order GET resultUrl:

{
  "orderId": "co_zz_4O3wnpE5u1K5AXnkARuhp-list-docs-zz-org_01ABC-20261121130000",
  "kausateId": "co_zz_4O3wnpE5u1K5AXnkARuhp",
  "companyName": "Sandbox Logistics GmbH",
  "customerReference": null,
  "metadata": null,
  "customerId": null,
  "status": "completed",
  "requestTime": "2026-11-21T13:00:00Z",
  "responseTime": "2026-11-21T13:00:00Z",
  "result": {
    "type": "listDocuments",
    "documents": [
      {
        "kausateDocumentId": "doc_zz-sandbox_4dfb09fa18c01b47facd01c6f593bc21",
        "title": "Annual Report 2024 — Sandbox Logistics GmbH",
        "documentType": "annualReport",
        "publicationType": "annualReport",
        "publicationDate": "2025-04-30",
        "fileType": "pdf",
        "source": "zz-sandbox"
      },
      {
        "kausateDocumentId": "doc_zz-sandbox_43554538711a96209820089856358ddf",
        "title": "Annual Report 2023 — Sandbox Logistics GmbH",
        "documentType": "annualReport",
        "publicationType": "annualReport",
        "publicationDate": "2024-04-30",
        "fileType": "pdf",
        "source": "zz-sandbox"
      }
    ],
    "totalCount": 2,
    "indexedAt": "2026-11-21T13:00:00Z",
    "expiresAt": null
  },
  "error": null,
  "code": null,
  "currentActivity": null,
  "waitingMessage": null,
  "cachedOrder": false
}

Filter on documentType to pick a document class across countries, and show title to people: it is the register's own name for the filing.

POST
/v2/companies/documents/list
X-API-Key<token>

Sign up at Kausate.com to get an API key

In: header

Query Parameters

batch?boolean

Set to true for batch orders: many orders you submit together and do not need answered immediately. They run at a lower priority than interactive orders.

Defaultfalse

Header Parameters

Kausate-Version?string
Default"2026-08-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

application/json

application/json

application/json

curl -X POST "https://api.kausate.com/v2/companies/documents/list" \  -H "X-API-Key: $KAUSATE_API_KEY" \  -H "Kausate-Version: 2026-08-01" \  -H "Content-Type: application/json" \  -d '{  "kausateId": "co_zz_4O3wnpE5u1K5AXnkARuhp"}'
{
  "orderId": "co_de_4JFFrsbQ99t1nmRw2JgzmG-list-docs-de-org_01ABC-20251125220000",
  "customerReference": "my-ref-123",
  "metadata": {
    "team": "kyb",
    "ticket": "ACME-42"
  },
  "cachedOrder": false,
  "resultUrl": "/v2/companies/documents/list/co_de_4JFFrsbQ99t1nmRw2JgzmG-list-docs-de-org_01ABC-20251125220000"
}
{
  "detail": "Invalid company ID format",
  "code": "request.invalid",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "API key is required",
  "code": "auth.unauthorized",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "Invalid API key",
  "code": "auth.forbidden",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "Company not found",
  "code": "company.not_found",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": [
    {
      "loc": [
        "body",
        "kausateId"
      ],
      "msg": "Field required",
      "type": "missing"
    }
  ],
  "code": "request.invalid",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "The data source is rate-limiting requests right now, please try again later",
  "code": "source.rate_limited",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "An unexpected error occurred. If this persists, please contact support@kausate.com",
  "code": "internal.unexpected",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "This capability is offered for the requested jurisdiction but is not usable right now because of a fault on our side. Please contact support@kausate.com",
  "code": "capability.not_available",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "Network error while reaching the data source",
  "code": "source.network_error",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "Data source temporarily unavailable",
  "code": "source.unavailable",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

Last updated on