Shareholder Graph (real-time)
Extract Shareholder Graph (sync)
Extract a shareholder graph synchronously. Blocks for up to 300 seconds. Only `maxDepth=1` is supported for sync requests — deeper graphs exceed the 300s budget. Requests with `maxDepth>1` are rejected with 400; use the async `POST /v2/companies/shareholder-graph` endpoint for multi-level extraction.
The async POST /v2/companies/shareholder-graph
endpoint is the preferred method. Government registries frequently time out —
async with webhooks or polling handles those failures gracefully.
Authorization
api_key X-API-Key<token>
Sign up at Kausate.com to get an API key
In: header
Query Parameters
batch?boolean
Mark as a batch/backfill request. Batch requests run at lowest priority to avoid blocking interactive queries.
Default
falseHeader Parameters
Kausate-Version?string
Default
"2026-05-01"Format
dateX-Customer-Id?|
Optional customer ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.kausate.com/v2/companies/shareholder-graph/sync" \ -H "Kausate-Version: 2026-05-01" \ -H "Content-Type: application/json" \ -d '{ "kausateId": "string" }'{
"orderId": "string",
"kausateId": "string",
"companyName": "string",
"customerReference": "string",
"metadata": {},
"customerId": "string",
"status": "running",
"requestTime": "2019-08-24T14:15:22Z",
"responseTime": "2019-08-24T14:15:22Z",
"result": {
"type": "shareholderGraph",
"graph": {
"nodes": [
{
"id": "string",
"type": "company",
"data": {
"kausateId": "string",
"legalName": "string",
"jurisdictionCode": "ec",
"identifiers": [
{
"value": "string",
"type": "ad_commercial_register_number",
"source": "string",
"description": "string",
"extra": {
"jurisdiction": "string",
"jurisdictionCode": "string",
"court": "string",
"courtId": "string",
"districtCourt": "string",
"registerType": "string",
"registerName": "string",
"authority": "string",
"issuerHint": "string",
"issuerJurisdiction": "string",
"issuerJurisdictionCandidates": [
"string"
],
"sourceField": "string",
"sourceDataset": "string",
"sourceFieldPath": "string",
"sourceRecordType": "string",
"sourceRecordId": "string",
"sourceSnapshotDate": "string",
"sourceDocumentType": "string",
"sourceOriginal": "string",
"sourceRelationship": "string",
"sourceExtractor": "string",
"sourceExtractionConfidence": "string",
"sourceValidationStatus": "string",
"subjectSeat": "string",
"subjectJurisdictionCandidates": [
"string"
],
"classificationEvidenceKind": "string",
"classificationEvidence": "string",
"classificationDisposition": "string",
"classificationAbstentionReason": "string",
"classificationValidated": true,
"classificationCollisionCount": 1,
"classificationKnownReassigned": true,
"inferredRegisterType": "string",
"registerTypeEvidence": "string",
"indexCorroborated": true,
"indexCorroborationMethod": "string",
"unknownMetadata": {
"category": "reported_identity",
"reason": "lifecycle_unstable",
"sourceLabel": "string",
"jurisdictionHint": "string"
},
"reportIdentifierPolicy": "string",
"reportIdentifierClassifier": "string",
"reportIdentifierReason": "string",
"validationStatus": "string",
"validationDetail": "string",
"identifierCorroborated": true,
"matchedBy": "string",
"corroborationProvider": "string",
"corroborationBackend": "string",
"corroborationMethod": "string",
"corroborationMatchedName": "string",
"corroborationMatchedNameKind": "string",
"corroborationNameSimilarityScore": 100,
"corroborationNameSimilarityThreshold": 100,
"corroborationNameSimilarityMargin": 100,
"corroborationAuthority": "string",
"gstRegistered": true,
"gstStatus": "string",
"gstStatusFrom": "string",
"legalAuthority": "string",
"legalForm": "string",
"placeRegistered": "string",
"countryRegistered": "string",
"nis": "string",
"ceidgRegistryNumber": "string",
"accountStatus": "string",
"sealSince": 0,
"swish": "string",
"jo_company_type_code": "string",
"last_financial_filing_year": "string",
"mortgage_status": "string",
"seizure_status": "string",
"management_mandate": "string",
"audit": {
"disposition": "strong_identifier",
"corroboration": "fully_corroborated",
"dispositionReasons": [
"uuid_shaped_value"
],
"decidedAt": "2019-08-24T14:15:22Z",
"events": [
{
"type": "observed",
"at": "2019-08-24T14:15:22Z",
"source": {
"type": "official_register",
"jurisdiction": "string",
"asOf": "2019-08-24",
"url": "http://example.com"
}
}
]
}
}
}
],
"cumulativeOwnership": {
"exact": 100,
"maximum": 100,
"minimum": 100,
"exclusiveMinimum": 100,
"exclusiveMaximum": 100
},
"status": {
"original": "string",
"normalized": "active",
"isActive": true
},
"sourceIds": [
"string"
]
}
}
],
"edges": [
{
"id": "string",
"source": "string",
"target": "string",
"data": {
"interestType": "shareholding",
"interestDetails": "string",
"role": {
"original": "string",
"englishTranslation": "string",
"originalLanguage": "string",
"iso5009RoleCode": "string",
"normalized": "Director"
},
"percentage": {
"exact": 100,
"maximum": 100,
"minimum": 100,
"exclusiveMinimum": 100,
"exclusiveMaximum": 100
},
"shareClass": "string",
"numberOfShares": 0,
"totalNominalValue": {
"amount": "string",
"iso4217CurrencyCode": "string"
},
"sourceId": "string"
}
}
],
"rootCompanyId": "string",
"maxDepth": 0,
"extractionTimestamp": "string",
"sources": {
"property1": {
"type": "selfDeclaration",
"name": "string",
"jurisdictionCode": "ec",
"retrievalTime": "string",
"downloadUrl": "string",
"fileHash": "string",
"fileName": "string",
"date": {
"original": "string",
"normalized": "string"
}
},
"property2": {
"type": "selfDeclaration",
"name": "string",
"jurisdictionCode": "ec",
"retrievalTime": "string",
"downloadUrl": "string",
"fileHash": "string",
"fileName": "string",
"date": {
"original": "string",
"normalized": "string"
}
}
},
"stopReason": "completed",
"stopReasonDetail": "string"
}
},
"error": "string",
"currentActivity": "string",
"cachedOrder": false
}{
"detail": "Invalid company ID format"
}{
"detail": "Invalid API key"
}{
"detail": "Insufficient credits. Required: 10, Available: 5"
}{
"detail": "Company not found"
}{
"detail": "Request timed out after 300 seconds. The workflow has been cancelled."
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"detail": "An internal error occurred"
}Last updated on