Skip to main content
POST
/
v2
/
companies
/
{kausateId}
/
shareholder-graph
Extract Multi-Level Shareholder Graph (real-time)
curl --request POST \
  --url https://api.kausate.com/v2/companies/{kausateId}/shareholder-graph \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "customerReference": "<string>",
  "maxDepth": 3
}
'
{
  "orderId": "shareholder-graph-co_de_abc123-20240319143022",
  "customerReference": "my-ref-123",
  "status": "completed",
  "requestTime": "2024-03-19T14:30:22.787045Z",
  "responseTime": "2024-03-19T14:35:45.108791Z",
  "result": {
    "type": "shareholderGraph",
    "graph": {
      "nodes": [
        {
          "id": "co_de_abc123",
          "type": "rootEntity",
          "data": {
            "kausateId": "co_de_abc123",
            "legalName": "Parent Company GmbH",
            "jurisdictionCode": "de",
            "identifiers": [
              {
                "value": "co_de_abc123",
                "type": "kausate_id",
                "description": "Kausate universal company identifier"
              },
              {
                "value": "D2601V_HRB123456",
                "type": "de_registernumber_full",
                "description": "German commercial register number with court code"
              }
            ],
            "cumulativeOwnership": {
              "exact": 100
            },
            "shareholderReport": {
              "sources": {
                "handelsregister_shareholder_abc123": {
                  "type": "officialRegister",
                  "name": "Handelsregister Deutschland",
                  "jurisdictionCode": "de",
                  "retrievalTime": "2024-03-19T14:30:00Z",
                  "downloadUrl": "https://www.kausate.com/downloads/sample.pdf",
                  "fileHash": "abc123...",
                  "fileName": "sample.pdf",
                  "date": {
                    "original": "2024-03-15",
                    "normalized": "2024-03-15"
                  }
                }
              },
              "shareholders": [
                {
                  "type": "company",
                  "company": {
                    "name": "Subsidiary AG",
                    "jurisdictionCode": "de",
                    "identifiers": [
                      {
                        "value": "HRB 98765",
                        "type": "de_registernumber_weak",
                        "description": "AG Frankfurt"
                      },
                      {
                        "value": "co_de_xyz789",
                        "type": "kausate_id",
                        "description": "Kausate Universal Identifier"
                      }
                    ]
                  },
                  "numberOfShares": 750,
                  "percentage": {
                    "exact": 75
                  },
                  "totalNominalValue": {
                    "amount": "75000",
                    "iso4217CurrencyCode": "EUR"
                  },
                  "interestType": "SHAREHOLDING",
                  "source": "handelsregister_shareholder_abc123"
                },
                {
                  "type": "person",
                  "person": {
                    "jurisdictionCode": "de",
                    "name": {
                      "firstName": "John",
                      "lastName": "Doe",
                      "fullName": "John Doe"
                    }
                  },
                  "numberOfShares": 250,
                  "percentage": {
                    "exact": 25
                  },
                  "totalNominalValue": {
                    "amount": "25000",
                    "iso4217CurrencyCode": "EUR"
                  },
                  "interestType": "SHAREHOLDING",
                  "source": "handelsregister_shareholder_abc123"
                }
              ]
            }
          }
        },
        {
          "id": "co_de_xyz789",
          "type": "company",
          "data": {
            "kausateId": "co_de_xyz789",
            "legalName": "Subsidiary AG",
            "jurisdictionCode": "de",
            "identifiers": [
              {
                "value": "co_de_xyz789",
                "type": "kausate_id",
                "description": "Kausate universal company identifier"
              },
              {
                "value": "HRB 98765",
                "type": "de_registernumber_weak",
                "description": "German commercial register number"
              }
            ],
            "cumulativeOwnership": {
              "exact": 75
            }
          }
        },
        {
          "id": "person_John_Doe",
          "type": "person",
          "data": {
            "name": "John Doe",
            "cumulativeOwnership": {
              "exact": 25
            }
          }
        }
      ],
      "edges": [
        {
          "id": "co_de_abc123-co_de_xyz789",
          "source": "co_de_abc123",
          "target": "co_de_xyz789",
          "data": {
            "interestType": "SHAREHOLDING",
            "percentage": {
              "exact": 75
            },
            "numberOfShares": 750,
            "totalNominalValue": {
              "amount": "75000",
              "iso4217CurrencyCode": "EUR"
            }
          }
        },
        {
          "id": "co_de_abc123-person_John_Doe",
          "source": "co_de_abc123",
          "target": "person_John_Doe",
          "data": {
            "interestType": "SHAREHOLDING",
            "percentage": {
              "exact": 25
            },
            "numberOfShares": 250,
            "totalNominalValue": {
              "amount": "25000",
              "iso4217CurrencyCode": "EUR"
            }
          }
        }
      ],
      "rootCompanyId": "co_de_abc123",
      "maxDepth": 3,
      "extractionTimestamp": "2024-03-19T14:30:22Z"
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

Sign up at Kausate.com to get an API key

Headers

​
X-Partner-Customer-Id
string | null

Optional partner customer ID

Path Parameters

​
kausateId
string
required

Company ID

Body

application/json

Request model for multi-level shareholder extraction (shareholder graph).

​
customerReference
string | null
Maximum string length: 150
​
maxDepth
integer
default:3

Maximum depth of ownership levels to extract (1-7)

Required range: 1 <= x <= 7

Response

Multi-level shareholder graph extraction order successfully placed

Response model for product order.

​
orderId
string
required
​
customerReference
string | null
Maximum string length: 150
​
partnerCustomerId
string | null
Maximum string length: 150