KausateKausate Docs

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"2026-05-01"
Formatdate

Response Body

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: 2026-05-01"
{
  "slug": "string",
  "orderId": "string",
  "kausateId": "string",
  "publicUrl": "string",
  "jsonUrl": "string",
  "publishedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": "Invalid company ID format"
}
{
  "detail": "Invalid API key"
}
{
  "detail": "Insufficient credits. Required: 10, Available: 5"
}
{
  "detail": "Company not found"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}
{
  "detail": "An internal error occurred"
}

Last updated on