Skip to main content
GET
/
companies
/
{id}
/
graph
Get ownership/role graph for a company
curl --request GET \
  --url https://lens-api.tic.io/companies/{id}/graph \
  --header 'x-api-key: <api-key>'
{
  "edges": [
    {
      "id": "<string>",
      "start": "<string>",
      "end": "<string>",
      "label": "<string>",
      "properties": {}
    }
  ],
  "nodes": [
    {
      "id": "<string>",
      "label": "<string>",
      "properties": {}
    }
  ],
  "isTruncated": true,
  "maxNodesLimit": 123,
  "truncatedAtStage": "<string>",
  "networkRisk": {
    "score": 123,
    "totalCompanies": 123,
    "highRiskCompanies": 123,
    "highRiskCompaniesPercent": 123,
    "totalPersons": 123,
    "highlightedPersons": 123,
    "highlightedPersonsPercent": 123,
    "details": [
      {
        "type": "<string>",
        "id": "<string>",
        "name": "<string>",
        "intelligenceScoreTotal": 123,
        "highlight": true
      }
    ]
  },
  "watchlists": [
    {
      "watchlistGuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "watchlistName": "<string>"
    }
  ]
}
Max+ tier

Authorizations

x-api-key
string
header
required

Path Parameters

id
integer<int32>
required

Internal company ID

Query Parameters

includeBeneficialOwner
boolean
default:true

Include beneficial-owner edges

highlightDebtBalance
boolean
default:true

Highlight nodes with outstanding KFM debt balances

highlightRecordOfNonPayment
boolean
default:true

Highlight nodes with KFM records of non-payment

limitMaxRoleInCompanies
integer<int32>
default:300

Maximum number of companies to expand per role. Default 300.

maxTotalNodes
integer<int32>
default:10000

Maximum total nodes in the returned graph. Default 10 000.

Response

ORB graph

edges
null | object[]
nodes
null | object[]
isTruncated
boolean
maxNodesLimit
null | integer<int32>
truncatedAtStage
null | string
networkRisk
object
watchlists
null | object[]