Get ownership/role graph for a company

Max+ tier

GEThttps://lens-api.tic.io/companies/{id}/graph

Authorization

x-api-keystringheaderrequired

Your API key, sent in the x-api-key header.

Path parameters

idintegerrequired

Internal company ID

format: int32

Query parameters

includeBeneficialOwnerboolean

Include beneficial-owner edges

default: true

highlightDebtBalanceboolean

Highlight nodes with outstanding KFM debt balances

default: true

highlightRecordOfNonPaymentboolean

Highlight nodes with KFM records of non-payment

default: true

limitMaxRoleInCompaniesinteger

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

format: int32 · default: 300

maxTotalNodesinteger

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

format: int32 · default: 10000

Responses

ORB graph · application/json

edgesORBEdge[] | null

Hide child attributes

idstring | null

startstring | null

endstring | null

labelstring | null

propertiesobject | null

Show child attributes

Additional properties: any

nodesORBNode[] | null

Hide child attributes

idstring | null

labelstring | null

propertiesobject | null

Show child attributes

Additional properties: any

isTruncatedboolean

maxNodesLimitinteger | null

format: int32

truncatedAtStagestring | null

networkRiskNetworkRisk

Hide child attributes

scorenumber

format: double

totalCompaniesinteger

format: int32

highRiskCompaniesinteger

format: int32

highRiskCompaniesPercentnumber

format: double

totalPersonsinteger

format: int32

highlightedPersonsinteger

format: int32

highlightedPersonsPercentnumber

format: double

detailsNetworkRiskDetail[] | null

Show child attributes

typestring | null

idstring | null

namestring | null

intelligenceScoreTotalnumber | null

format: double

highlightboolean | null

watchlistsGraphWatchlist[] | null

Hide child attributes

watchlistGuidstring

format: uuid

watchlistNamestring | null

{ "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.45, "totalCompanies": 123, "highRiskCompanies": 123, "highRiskCompaniesPercent": 123.45, "totalPersons": 123, "highlightedPersons": 123, "highlightedPersonsPercent": 123.45, "details": [ { "type": "<string>", "id": "<string>", "name": "<string>", "intelligenceScoreTotal": 123.45, "highlight": true } ] }, "watchlists": [ { "watchlistGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "watchlistName": "<string>" } ] }