Company Data
Extract Shareholder Graph (real-time)
Extract multi-level shareholder graph for a company.
Authorization
api_key X-API-Key<token>
Sign up at Kausate.com to get an API key
In: header
Path Parameters
kausateId*string
Header Parameters
X-Partner-Customer-Id?|
Optional partner customer ID
Request Body
application/json
customerReference?|
maxDepth?integer
Maximum depth of ownership levels to extract (1-7)
Default
3Range
1 <= value <= 7retrievalTimeout?|
Maximum time in minutes for document retrieval activities.
bypassCache?boolean
If true, bypass daily deduplication and force a fresh request.
Default
falseResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.kausate.com/v2/companies/string/shareholder-graph" \ -H "Content-Type: application/json" \ -d '{}'{
"orderId": "shareholder-graph-co_de_4JFFrsbQ99t1nmRw2JgzmG-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_4JFFrsbQ99t1nmRw2JgzmG",
"type": "rootEntity",
"data": {
"kausateId": "co_de_4JFFrsbQ99t1nmRw2JgzmG",
"legalName": "Parent Company GmbH",
"jurisdictionCode": "de",
"identifiers": [
{
"value": "co_de_4JFFrsbQ99t1nmRw2JgzmG",
"type": "kausate_id",
"description": "Kausate universal company identifier"
},
{
"value": "4JFFrsbQ99t1nmRw2JgzmG",
"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_5KGGtcdR00u2onSx3KhAnH",
"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_5KGGtcdR00u2onSx3KhAnH",
"type": "company",
"data": {
"kausateId": "co_de_5KGGtcdR00u2onSx3KhAnH",
"legalName": "Subsidiary AG",
"jurisdictionCode": "de",
"identifiers": [
{
"value": "co_de_5KGGtcdR00u2onSx3KhAnH",
"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_4JFFrsbQ99t1nmRw2JgzmG-co_de_5KGGtcdR00u2onSx3KhAnH",
"source": "co_de_4JFFrsbQ99t1nmRw2JgzmG",
"target": "co_de_5KGGtcdR00u2onSx3KhAnH",
"data": {
"interestType": "SHAREHOLDING",
"percentage": {
"exact": 75
},
"numberOfShares": 750,
"totalNominalValue": {
"amount": "75000",
"iso4217CurrencyCode": "EUR"
}
}
},
{
"id": "co_de_4JFFrsbQ99t1nmRw2JgzmG-person_John_Doe",
"source": "co_de_4JFFrsbQ99t1nmRw2JgzmG",
"target": "person_John_Doe",
"data": {
"interestType": "SHAREHOLDING",
"percentage": {
"exact": 25
},
"numberOfShares": 250,
"totalNominalValue": {
"amount": "25000",
"iso4217CurrencyCode": "EUR"
}
}
}
],
"rootCompanyId": "co_de_4JFFrsbQ99t1nmRw2JgzmG",
"maxDepth": 3,
"extractionTimestamp": "2024-03-19T14:30:22Z"
}
}
}{
"detail": "Invalid company ID format"
}{
"detail": "Invalid API key"
}{
"detail": "Insufficient credits. Required: 10, Available: 5"
}{
"detail": "Company not found"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}{
"detail": "An internal error occurred"
}Last updated on