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

Publish Shareholder Graph

Publish a completed shareholder-graph order behind an unguessable public URL. The returned `publicUrl` renders the same UBO studio visualization as the authenticated app. The slug is a capability token — anyone holding it can view the graph, so treat it like a secret.

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

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 publish

Header Parameters

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

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/shareholder-graph/string/publish" \  -H "Kausate-Version: 2025-04-01"
{
  "slug": "string",
  "orderId": "string",
  "kausateId": "string",
  "publicUrl": "string",
  "jsonUrl": "string",
  "publishedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": "Invalid company ID format",
  "code": "request.invalid",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "Not authenticated",
  "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",
        "jurisdictionCode"
      ],
      "msg": "Field required",
      "type": "missing"
    }
  ],
  "code": "request.invalid",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "Rate limit exceeded, please try again later",
  "code": "source.rate_limited",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "An internal error occurred",
  "code": "internal.unexpected",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "This capability is not available for this jurisdiction",
  "code": "capability.not_available",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "Network connection error",
  "code": "source.network_error",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "Data source temporarily unavailable",
  "code": "source.unavailable",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

Last updated on

Extract Shareholder GraphPOST

Extract multi-level shareholder graph for a company.

Extend Shareholder GraphPOST

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). Charges once per extended node, at the extension SKU of that node's jurisdiction — for an exact, uncharged preview of the cost, call the sibling POST /v2/companies/shareholder-graph/{orderId}/extend/quote with the same body first. Returns a new async order; poll GET /v2/companies/shareholder-graph/{orderId} or subscribe via webhook.