KausateKausate Docs
2025-04-01Company Data
Viewing API version 2025-04-01. View the latest version.

Extend Shareholder Graph

Extend a completed shareholder graph by continuing its traversal deeper. Resumes from the referenced order's persisted state and extracts `additionalDepth` further ownership levels from its unexpanded frontier (or from the specific `extendNodeIds` if given). Returns a new async order; poll GET /v2/companies/shareholder-graph/{orderId} or subscribe via webhook.

POST
/v2/companies/shareholder-graph/{orderId}/extend

Authorization

api_key
X-API-Key<token>

Sign up at Kausate.com to get an API key

In: header

Path Parameters

orderId*string

Completed shareholder-graph order ID to extend

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

application/json

curl -X POST "https://api.kausate.com/v2/companies/shareholder-graph/string/extend" \  -H "Kausate-Version: 2025-04-01" \  -H "Content-Type: application/json" \  -d '{}'
{
  "orderId": "string",
  "kausateId": "string",
  "customerReference": "string",
  "customerId": "string"
}
{
  "detail": "Invalid company ID format"
}
{
  "detail": "Invalid API key"
}
{
  "detail": "Insufficient credits. Required: 10, Available: 5"
}
{
  "detail": "Company not found"
}
{
  "detail": "Order '...' is still running; wait for it to complete before requesting an extension."
}
{
  "detail": "The continuation state for this order has expired or was never persisted. Order a fresh shareholder graph instead."
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}
{
  "detail": "An internal error occurred"
}

Last updated on