Quote Shareholder Graph Extension

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`

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",
  "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": "Order '...' is still running; wait for it to complete before requesting an extension.",
  "code": "resource.conflict",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "The continuation state for this order has expired or was never persisted. Order a fresh shareholder graph instead.",
  "code": "order.continuation_state_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"
}

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 an extension in the node's jurisdiction. Nodes the extension would skip (and never charge) are listed under `excludedNodes` with the reason. Nothing is ordered or 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.

Authorization

api_key

X-API-Key<token>

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.

customerReference?|

metadata?|

Optional customer-supplied JSON metadata echoed back in order responses. Serialized JSON must be at most 4096 bytes.

additionalDepth?integer

Number of additional ownership levels to extract beyond each expanded frontier node (1-7).

Default1

Range1 <= value <= 7

extendNodeIds?array<>|

Specific company node IDs to expand; defaults to every unexpanded node at the frontier.

bypassCache?boolean

If true, bypass daily deduplication and force a fresh request.

Defaultfalse

retrievalTimeout?|

Maximum time in minutes to wait for document retrieval (30–2880).

Response Body

`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",
  "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": "Order '...' is still running; wait for it to complete before requesting an extension.",
  "code": "resource.conflict",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "The continuation state for this order has expired or was never persisted. Order a fresh shareholder graph instead.",
  "code": "order.continuation_state_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"
}

Quote Shareholder Graph Extension

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

410application/json

422application/json

429application/json

500application/json

501application/json

502application/json

503application/json

Quote Shareholder Graph Extension

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

410application/json

422application/json

429application/json

500application/json

501application/json

502application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`