Skip to main content
GET
/
datasets
/
persons
/
{personId}
/
graph
Graph
curl --request GET \
  --url https://api.tic.io/datasets/persons/{personId}/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
      }
    ]
  }
}
Returns a graph with nodes and edges representing the relationships between persons and companies and optionally beneficial owners. Can be used by graph visualization such as: The properties for nodes and edges are dynamic and can be used to control styling and highlighting of nodes.

Authorizations

x-api-key
string
header
required

Path Parameters

personId
integer<int32>
required

The person id

Query Parameters

includeBeneficialOwner
boolean
default:true

Include or exclude beneficial owner

limitMaxRoleInCompanies
integer<int32>

Exclude nodes when person has more than the set number of maximum roles

maxTotalNodes
integer<int32>
default:10000

Max total nodes

Response

200 - application/json

OK

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