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

Quote Shareholder Graph Extension

Quote what extending a completed shareholder graph would cost — before ordering. Takes the same body as POST /v2/companies/shareholder-graph/{orderId}/extend and resolves exactly which nodes that extension would extend, pricing each at your organization's effective credit price for the node's jurisdiction extension SKU. Nodes the extension would skip (and never charge) are listed under `excludedNodes` with the reason. No workflow is started and nothing is charged. If every requested node is excluded, `orderWouldFail` is `true`: an identical extend order would be accepted but then fail asynchronously instead of completing as a free no-op.

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

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 quote an extension for

Header Parameters

Kausate-Version?string
Default"2025-04-01"
Formatdate

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/quote" \  -H "Kausate-Version: 2025-04-01" \  -H "Content-Type: application/json" \  -d '{}'
{
  "orderId": "string",
  "nodes": [
    {
      "nodeId": "string",
      "jurisdictionCode": "ec",
      "sku": "AAKEVT",
      "credits": 0
    }
  ],
  "excludedNodes": [
    {
      "nodeId": "string",
      "jurisdictionCode": "string",
      "reason": "string"
    }
  ],
  "totalCredits": 0,
  "orderWouldFail": true,
  "currency": "credits",
  "estimated": true,
  "additionalDepth": 0
}
{
  "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