Biz-KYC Shareholders API

Retrieve the shareholder structure of a Biz-KYC company, page by page.

ENDPOINTS

POST /api/v1/company/biz/shareholders

Request parameters

orgId

string

Company identifier returned by the Biz-KYC Company Search API

Required: Yes
Example: 5a1b2c3d4e5f000000000001

updateData

boolean

Bypass locally stored data and pull the latest records from the upstream source

Required: No
Example: false

Request Example

{
    "orgId": "5a1b2c3d4e5f000000000001",
    "page": 1,
    "updateData": false
}

curl https://api.tradedata.io/api/v1/company/biz/shareholders \
  -H "Authorization: Bearer yourTokenHere" \
  -H "Content-Type: application/json" \
  -d '{"orgId": "5a1b2c3d4e5f000000000001", "page": 1, "updateData": false}'

import requests

response = requests.post(
    "https://api.tradedata.io/api/v1/company/biz/shareholders",
    headers={
        "Authorization": "Bearer yourTokenHere",
        "Content-Type": "application/json",
    },
    json={
        "orgId": "5a1b2c3d4e5f000000000001",
        "page": 1,
        "updateData": False,
    },
)
print(response.json())

const response = await fetch("https://api.tradedata.io/api/v1/company/biz/shareholders", {
  method: "POST",
  headers: {
    "Authorization": "Bearer yourTokenHere",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "orgId": "5a1b2c3d4e5f000000000001",
    "page": 1,
    "updateData": false
  }),
});
const data = await response.json();

<?php
$ch = curl_init("https://api.tradedata.io/api/v1/company/biz/shareholders");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer yourTokenHere",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "orgId" => "5a1b2c3d4e5f000000000001",
        "page" => 1,
        "updateData" => false
    ]),
]);
echo curl_exec($ch);

Response parameters

code

int

Status code

Example: 200

data

array

Result container

data.shareholderName

string

Name of the shareholder, either an individual or an entity

Example: Acme Holdings Ltd.

data.shareholderDirect

string

Direct shareholding, expressed as a percentage or a descriptive value

Example: 60%

total

int

Total number of shareholder records available for this company

Example: 12

pageSize

int

Records per page, fixed at 20

Example: 20

Response Example

{
    "code": 200,
    "success": true,
    "data": [
        {
            "shareholderName": "Acme Holdings Ltd.",
            "shareholderDirect": "60%"
        },
        {
            "shareholderName": "John Doe",
            "shareholderDirect": "40%"
        }
    ],
    "total": 12,
    "pageSize": 20,
    "msg": "OK"
}

An empty data array is returned when orgId is missing or no shareholder record exists for the company.

Biz-KYC Decision Chain API

Retrieve the decision chain (directors and key officers) of a Biz-KYC company, page by page.