KYB शेयरधारक API

curl

curl -X POST https://verification.didit.me/v3/kyb/shareholders/ \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "kyb_response_id": "69aeeb95febb0f1704042259",
    "vendor_data": "company-1234"
  }'

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.kyb.list_shareholders(
    kyb_response_id="69aeeb95febb0f1704042259",
    vendor_data="company-1234",
)
print(result)

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.kyb.listShareholders({
  kyb_response_id: "69aeeb95febb0f1704042259",
  vendor_data: "company-1234",
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.KYB.ListShareholders(ctx, didit.KYBRegistryCandidateRequest{
	KYBResponseID: "69aeeb95febb0f1704042259",
	VendorData:    didit.String("company-1234"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.KYBRegistryCandidateRequest;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.kyb().listShareholders(KYBRegistryCandidateRequest.builder()
        .kybResponseId("69aeeb95febb0f1704042259")
        .vendorData("company-1234")
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->kyb->listShareholders([
    'kyb_response_id' => '69aeeb95febb0f1704042259',
    'vendor_data' => 'company-1234',
]);
print_r($result->toArray());

require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.kyb.list_shareholders(
  kyb_response_id: "69aeeb95febb0f1704042259",
  vendor_data: "company-1234"
)
puts result.to_h

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Kyb.ListShareholdersAsync(new KYBRegistryCandidateRequest
{
    KybResponseId = "69aeeb95febb0f1704042259",
    VendorData = "company-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e",
  "kyb_registry": {
    "uuid": "f1e2d3c4-b5a6-4789-9c0d-1e2f3a4b5c6d",
    "node_id": "feature_kyb_registry",
    "status": "In Review",
    "registry_status": "active",
    "data_resolved": true,
    "company_name": "Tesco PLC",
    "registration_number": "00445790",
    "country_code": "GB",
    "region": "",
    "company_type": "Public Limited Company",
    "incorporation_date": "1947-11-27",
    "registered_address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA",
    "tax_number": "GB412 8925 93",
    "risk_level": "low risk",
    "verification_status": "verified",
    "is_from_registry": true,
    "fetch_status": "resolved",
    "alternative_names": "TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY",
    "nature_of_business": null,
    "registered_capital": null,
    "registered_capital_amount": null,
    "registered_capital_currency": null,
    "website": "https://www.tesco.com/",
    "email": "customer.service@tesco.co.uk",
    "phone": "03301231688",
    "legal_entity_identifier": null,
    "location_of_registration": null,
    "financial_summary": {
      "currency": "Pound (£)",
      "total_number_of_shares": "8174378721",
      "meta_detail": {
        "Class_Of_Share": "Ordinary"
      }
    },
    "officers": [
      {
        "uuid": "a1b2c3d4-e5f6-4789-9a0b-1c2d3e4f5a6b",
        "name": "CHRISTOPHER JON TAYLOR",
        "designation": "Secretary",
        "role": "secretary",
        "nationality": null,
        "is_active": true,
        "kyc_status": null,
        "kyc_session_url": null
      },
      {
        "uuid": "b2c3d4e5-f6a7-4890-8b1c-2d3e4f5a6b7c",
        "name": "MELISSA BETHELL",
        "designation": "Director",
        "role": "director",
        "nationality": "British",
        "is_active": true,
        "kyc_status": null,
        "kyc_session_url": null
      }
    ],
    "beneficial_owners": [],
    "addresses": [
      {
        "address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA",
        "type": "legal_entity_registry_address",
        "description": "registered office address"
      }
    ],
    "industries": null,
    "accounts": {
      "last_account": "26 February 2025",
      "next_account": "26 February 2026",
      "due_by_date": "26 August 2026"
    },
    "registry_data": {},
    "user_provided_data": null,
    "confirmed_by_user_at": null,
    "last_console_edit_at": null,
    "is_editable": true
  },
  "vendor_data": "company-1234",
  "metadata": null,
  "created_at": "2026-06-11T10:45:00.000000+00:00"
}

POST

kyb

shareholders

curl

curl -X POST https://verification.didit.me/v3/kyb/shareholders/ \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "kyb_response_id": "69aeeb95febb0f1704042259",
    "vendor_data": "company-1234"
  }'

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.kyb.list_shareholders(
    kyb_response_id="69aeeb95febb0f1704042259",
    vendor_data="company-1234",
)
print(result)

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.kyb.listShareholders({
  kyb_response_id: "69aeeb95febb0f1704042259",
  vendor_data: "company-1234",
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.KYB.ListShareholders(ctx, didit.KYBRegistryCandidateRequest{
	KYBResponseID: "69aeeb95febb0f1704042259",
	VendorData:    didit.String("company-1234"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.KYBRegistryCandidateRequest;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.kyb().listShareholders(KYBRegistryCandidateRequest.builder()
        .kybResponseId("69aeeb95febb0f1704042259")
        .vendorData("company-1234")
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->kyb->listShareholders([
    'kyb_response_id' => '69aeeb95febb0f1704042259',
    'vendor_data' => 'company-1234',
]);
print_r($result->toArray());

require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.kyb.list_shareholders(
  kyb_response_id: "69aeeb95febb0f1704042259",
  vendor_data: "company-1234"
)
puts result.to_h

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Kyb.ListShareholdersAsync(new KYBRegistryCandidateRequest
{
    KybResponseId = "69aeeb95febb0f1704042259",
    VendorData = "company-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e",
  "kyb_registry": {
    "uuid": "f1e2d3c4-b5a6-4789-9c0d-1e2f3a4b5c6d",
    "node_id": "feature_kyb_registry",
    "status": "In Review",
    "registry_status": "active",
    "data_resolved": true,
    "company_name": "Tesco PLC",
    "registration_number": "00445790",
    "country_code": "GB",
    "region": "",
    "company_type": "Public Limited Company",
    "incorporation_date": "1947-11-27",
    "registered_address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA",
    "tax_number": "GB412 8925 93",
    "risk_level": "low risk",
    "verification_status": "verified",
    "is_from_registry": true,
    "fetch_status": "resolved",
    "alternative_names": "TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY",
    "nature_of_business": null,
    "registered_capital": null,
    "registered_capital_amount": null,
    "registered_capital_currency": null,
    "website": "https://www.tesco.com/",
    "email": "customer.service@tesco.co.uk",
    "phone": "03301231688",
    "legal_entity_identifier": null,
    "location_of_registration": null,
    "financial_summary": {
      "currency": "Pound (£)",
      "total_number_of_shares": "8174378721",
      "meta_detail": {
        "Class_Of_Share": "Ordinary"
      }
    },
    "officers": [
      {
        "uuid": "a1b2c3d4-e5f6-4789-9a0b-1c2d3e4f5a6b",
        "name": "CHRISTOPHER JON TAYLOR",
        "designation": "Secretary",
        "role": "secretary",
        "nationality": null,
        "is_active": true,
        "kyc_status": null,
        "kyc_session_url": null
      },
      {
        "uuid": "b2c3d4e5-f6a7-4890-8b1c-2d3e4f5a6b7c",
        "name": "MELISSA BETHELL",
        "designation": "Director",
        "role": "director",
        "nationality": "British",
        "is_active": true,
        "kyc_status": null,
        "kyc_session_url": null
      }
    ],
    "beneficial_owners": [],
    "addresses": [
      {
        "address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA",
        "type": "legal_entity_registry_address",
        "description": "registered office address"
      }
    ],
    "industries": null,
    "accounts": {
      "last_account": "26 February 2025",
      "next_account": "26 February 2026",
      "due_by_date": "26 August 2026"
    },
    "registry_data": {},
    "user_provided_data": null,
    "confirmed_by_user_at": null,
    "last_console_edit_at": null,
    "is_editable": true
  },
  "vendor_data": "company-1234",
  "metadata": null,
  "created_at": "2026-06-11T10:45:00.000000+00:00"
}

इस endpoint का उपयोग POST /v3/kyb/search/ द्वारा संभावित कंपनियाँ लौटाए जाने के बाद तब करें जब आपको Lite प्रोफ़ाइल के साथ प्रत्यक्ष शेयरधारक भी चाहिए। इसका शुल्क उस देश के Shareholders मूल्य पर लिया जाता है (प्रति-देश मूल्य)। जब रजिस्ट्री में कंपनी के लिए कोई शेयरधारक रिकॉर्ड न हो, या देश में स्वामित्व का कोई डेटा उपलब्ध न हो, तब इसके बजाय Lite प्रोफ़ाइल दी जाती है और उसी का शुल्क लिया जाता है: registry_tier_delivered basic होता है और registry_ownership_status unavailable होता है, या जब स्वामित्व स्रोत ने बताया हो कि उसके पास इस कंपनी का कोई रिकॉर्ड नहीं है, तब not_held होता है (स्वामित्व स्थिति)। जब रिपोर्ट अभी तैयार हो रही हो, या स्वामित्व अनुभाग अभी रजिस्ट्री से प्राप्त न हुआ हो, तब endpoint 202 Accepted, kyb_registry.fetch_status: "pending", kyb_registry.registry_ownership_status: "pending" और registry_tier_delivered: null लौटाता है। लौटाया गया request_id रखें और GET /v3/session/{request_id}/decision/ को तब तक कॉल करते रहें जब तक registry_checks[0].company.fetch_status resolved न हो जाए। Didit लंबित रिपोर्ट को अपने-आप पूरा करता है और तैयार होने पर दिए गए स्तर का शुल्क लेता है। लंबित रहने के दौरान खरीद अनुरोध दोबारा न भेजें: हर नया POST एक अलग अनुरोध बनाता है। केवल v3 पर उपलब्ध। POST /v2/kyb/select/ और POST /v3/kyb/select/ अपना अनुबंध और मूल्य बनाए रखते हैं।

प्राधिकरण

x-api-key

string

header

आवश्यक

आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी, कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं। देखें https://docs.didit.me/console/api-keys।

बॉडी

application/json

kyb_response_id

string

आवश्यक

POST /v3/kyb/search/ (kyb_registry.companies[].kyb_response_id) से कैंडिडेट हैंडल। अल्पकालिक: इसे उत्पन्न करने वाली खोज के तुरंत बाद उपयोग करें। हैंडल लंबे हो सकते हैं, इसलिए मान को बिना ट्रिम किए या लंबाई का अनुमान लगाए ठीक उसी तरह स्टोर करें और भेजें जैसा कि लौटाया गया है।

Maximum string length: 1024

उदाहरण:

"69aeeb95febb0f1704042259"

vendor_data

string

इस कंपनी के लिए आपका पहचानकर्ता; वापस दोहराया जाता है और व्यवसाय सत्र के साथ संग्रहीत किया जाता है।

metadata

object | null

व्यवसाय सत्र के साथ संग्रहीत और वापस लौटाया गया फ़्री-फ़ॉर्म JSON।

save_api_request

boolean

डिफ़ॉल्ट:true

true होना चाहिए (डिफ़ॉल्ट)। KYB रजिस्ट्री चयन हमेशा बनाए रखे जाते हैं ताकि बिलिंग और पुनर्प्राप्ति को ट्रैक किया जा सके; false 400 लौटाता है।

प्रतिक्रिया

कंपनी रिपोर्ट डिलीवर किए गए स्तर पर लौटाई और बिल की गई। अभी भी तैयार की जा रही स्वामित्व रिपोर्ट 202 लौटा सकती हैं; उनके सहेजे गए निर्णय को पुनः प्राप्त करने के लिए request_id रखें।

request_id

string<uuid>

इस पुनर्प्राप्ति के लिए बनाए गए व्यवसाय सत्र की Id। यदि रिस्पॉन्स के बाद रजिस्ट्री से जानकारी मिलती है, तो संग्रहीत रिकॉर्ड (कंसोल में दृश्यमान) अपडेट होता रहता है।

registry_tier_requested

enum<string>

यह endpoint जो स्तर बेचता है: चुनिंदा के लिए basic (Lite), shareholders, ubo।

उपलब्ध विकल्प:

basic,

shareholders,

ubo

registry_tier_delivered

enum<string> | null

वास्तव में डिलीवर और बिल किया गया स्तर। अनुरोध किए गए स्तर से कम तब होता है जब देश की रजिस्ट्रियों में कोई स्वामित्व डेटा नहीं होता है, या रजिस्ट्री में इस कंपनी के लिए कोई स्वामित्व रिकॉर्ड नहीं होता है।

उपलब्ध विकल्प:

basic,

shareholders,

ubo,

null

kyb_registry

object

पूर्ण रजिस्ट्री कंपनी प्रोफ़ाइल।

Show child attributes

vendor_data

string | null

आपके द्वारा भेजे गए vendor_data का इको।

metadata

object | null

आपके द्वारा भेजे गए metadata का इको।

created_at

string<date-time>

अंतिम संशोधन 7 नवंबर 2026