BREAGEN Logo
Knowledge Graph

Shareholder Graph

Initiate Graph Creating Process POST /v1/api/graph/shareholder

Resource URL/v1/api/graph/shareholder
Response FormatJSON
Requires AuthenticationNot specified
Rate LimitedNot specified
HTTPSAssumed Yes

Description

Initiate the graph creating process for shareholder data.

Request Body

ParameterDescriptionRequiredTypeDefault Value
linkURL link to the data sourceYesStringN/A
source_nameName of the sourceYesStringN/A
entity_nameName of the entityYesStringN/A
jurisdictionJurisdiction of the entityYesStringN/A
entity_idUnique ID of the entityYesStringN/A
client_idUnique ID of the clientYesStringN/A
levelsDepth levels for the graphYesIntegerN/A
min_indirect_percentageMinimum indirect ownership %YesIntegerN/A
max_indirect_percentageMaximum indirect ownership %YesIntegerN/A
usernameUsername initiating requestYesStringN/A
session_idSession ID for the requestYesStringN/A
entity_request_idOptional entity request IDYesString/NullN/A

Example Request

curl -X 'POST' \
'https://braegen.ai/v1/api/graph/shareholder' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{"link": "https://braegen.ai/data", "source_name": "SourceCorp", "entity_name": "EntityInc", "jurisdiction": "US", "entity_id": "12345", "client_id": "67890", "levels": 3, "min_indirect_percentage": 10, "max_indirect_percentage": 50, "username": "user1", "session_id": "abc123", "entity_request_id": null}'

Example Response

{
    "is_error": false,
    "message": "Graph creation initiated successfully",
    "results": {
        "request_id": "abc123",
        "entity_name": "EntityInc",
        "client_id": "67890"
    }
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

Graph Operations - Get Generated Graph GET /v1/api/graphshareholder/{request_id}

Resource URL/v1/api/graphshareholder/{request_id}
Response FormatJSON
Requires AuthenticationNot specified
Rate LimitedNot specified
HTTPSAssumed Yes

Parameters

ParameterDescriptionRequiredTypeDefault Value
request_idID of the requestYesStringN/A

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/graphshareholder/abc123' \
-H 'accept: application/json'

Example Response

{
    "is_error": false,
    "message": "Graph retrieved successfully",
    "results": {
        "request_id": "abc123",
        "graph_data": {
            "nodes": [{"id": "1", "name": "EntityInc"}, {"id": "2", "name": "SourceCorp"}],
            "edges": [{"source": "1", "target": "2", "relation": "owns"}]
        }
    }
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

Previous

Conflict Management

Next

Visual Link Analysis

On this page