> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tic.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Graph

> Returns a graph with persons, companies and optional beneficial owners

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:

* [Linkurious Ogma](https://resources.linkurious.com/ogma-overview)
* [Cambridge Intelligence Keylines](https://cambridge-intelligence.com/keylines-javascript-graph-visualization/)
* [Sigma.js](https://www.sigmajs.org/)
* [Memgraph Orb](https://github.com/memgraph/orb)

The properties for nodes and edges are dynamic and can be used to control styling and highlighting of nodes.


## OpenAPI

````yaml get /datasets/persons/{personId}/graph
openapi: 3.0.4
info:
  title: TIC API
  description: ''
  version: v1
servers:
  - url: https://api.tic.io/
security:
  - ApiKey: []
tags:
  - name: BolagsverketStatistics
  - name: Companies
  - name: Companies_SE_
  - name: DocumentDelivery
  - name: EuropeanCommission
  - name: FinancialDocuments
  - name: Finansinspektionen
  - name: Free
  - name: ICA
  - name: ICAStatistics
  - name: Lists
  - name: Media
  - name: Persons
  - name: Persons_SE_
  - name: Properties_SE_
  - name: PTSPortings
  - name: Reseller
  - name: SearchBankruptciesReports
  - name: SearchCompanies
  - name: SearchCompaniesReports
  - name: SearchCompanyWorkplaces
  - name: SearchPerson
  - name: SearchProperties_SE_
  - name: SearchVehicles
  - name: TeamDocumentOrders
  - name: Teams
  - name: User
  - name: Vehicles_SE_
  - name: WatchLists
paths:
  /datasets/persons/{personId}/graph:
    get:
      tags:
        - Persons
      summary: Graph
      description: Returns a graph with persons, companies and optional beneficial owners
      operationId: PersonGraph
      parameters:
        - name: personId
          in: path
          description: The person id
          required: true
          schema:
            type: integer
            format: int32
        - name: includeBeneficialOwner
          in: query
          description: Include or exclude beneficial owner
          schema:
            type: boolean
            default: true
        - name: limitMaxRoleInCompanies
          in: query
          description: >-
            Exclude nodes when person has more than the set number of maximum
            roles
          schema:
            type: integer
            format: int32
        - name: maxTotalNodes
          in: query
          description: Max total nodes
          schema:
            type: integer
            format: int32
            default: 10000
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ormeo_Library_Memgraph_ORB_ORBGraph'
components:
  schemas:
    Ormeo_Library_Memgraph_ORB_ORBGraph:
      type: object
      properties:
        edges:
          type: array
          items:
            $ref: '#/components/schemas/Ormeo_Library_Memgraph_ORB_ORBEdge'
          nullable: true
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/Ormeo_Library_Memgraph_ORB_ORBNode'
          nullable: true
        isTruncated:
          type: boolean
        maxNodesLimit:
          type: integer
          format: int32
          nullable: true
        truncatedAtStage:
          type: string
          nullable: true
        networkRisk:
          $ref: '#/components/schemas/Ormeo_Library_Memgraph_ORB_NetworkRisk'
        watchlists:
          type: array
          items:
            $ref: '#/components/schemas/Ormeo_Library_Memgraph_ORB_GraphWatchlist'
          nullable: true
      additionalProperties: false
    Ormeo_Library_Memgraph_ORB_ORBEdge:
      type: object
      properties:
        id:
          type: string
          nullable: true
        start:
          type: string
          nullable: true
        end:
          type: string
          nullable: true
        label:
          type: string
          nullable: true
        properties:
          type: object
          additionalProperties:
            nullable: true
          nullable: true
      additionalProperties: false
    Ormeo_Library_Memgraph_ORB_ORBNode:
      type: object
      properties:
        id:
          type: string
          nullable: true
        label:
          type: string
          nullable: true
        properties:
          type: object
          additionalProperties:
            nullable: true
          nullable: true
      additionalProperties: false
    Ormeo_Library_Memgraph_ORB_NetworkRisk:
      type: object
      properties:
        score:
          type: number
          format: double
        totalCompanies:
          type: integer
          format: int32
        highRiskCompanies:
          type: integer
          format: int32
        highRiskCompaniesPercent:
          type: number
          format: double
        totalPersons:
          type: integer
          format: int32
        highlightedPersons:
          type: integer
          format: int32
        highlightedPersonsPercent:
          type: number
          format: double
        details:
          type: array
          items:
            $ref: '#/components/schemas/Ormeo_Library_Memgraph_ORB_NetworkRiskDetail'
          nullable: true
      additionalProperties: false
    Ormeo_Library_Memgraph_ORB_GraphWatchlist:
      type: object
      properties:
        watchlistGuid:
          type: string
          format: uuid
        watchlistName:
          type: string
          nullable: true
      additionalProperties: false
    Ormeo_Library_Memgraph_ORB_NetworkRiskDetail:
      type: object
      properties:
        type:
          type: string
          nullable: true
        id:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        intelligenceScoreTotal:
          type: number
          format: double
          nullable: true
        highlight:
          type: boolean
          nullable: true
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: apiKey
      name: x-api-key
      in: header

````