मुख्य सामग्री पर जाएं
POST
curl
इस endpoint का उपयोग पहले कंपनी रजिस्ट्री में मिलान वाले उम्मीदवार खोजने के लिए करें। खोज एक सहेजी गई Manual Check नहीं बनाती। भुगतान वाले कंपनी-डेटा स्रोत का उपयोग करने वाली सफल स्टैंडअलोन खोजों की लागत $0.50 प्रति अनुरोध है, चाहे उम्मीदवारों की संख्या कितनी भी हो। खाली परिणाम, विफल खोजें, और केवल अन्य स्रोतों से मिले परिणाम शुल्क-योग्य नहीं हैं। बाद में प्रोफ़ाइल प्राप्त करने का शुल्क अलग से लिया जाता है। ऐसी खोज के लिए जो भुगतान वाला स्रोत उपयोग कर सकती है, Didit रजिस्ट्री से संपर्क करने से पहले लागू खोज कीमत की जाँच करता है और उसे आरक्षित करता है। अपर्याप्त बैलेंस पर 403 लौटता है, जिसमें code: "insufficient_credits" होता है। अनुबंधित बिलिंग आपकी सहमत खोज दर का पालन करती है; बिना कॉन्फ़िगर की गई अनुबंध दर खोज से पहले अस्वीकार कर दी जाती है। सैंडबॉक्स खोजें निःशुल्क हैं। हर दोहराई गई सफल खोज एक नया शुल्क-योग्य अनुरोध है; कॉलबैक डिलीवरी से खोज शुल्क नहीं जुड़ता। यदि आप webhook_url भेजते हैं, तो Didit प्रदाता द्वारा खोज हल होने के दौरान तुरंत उत्तर दे सकता है, और उम्मीदवार तैयार होने पर उन्हें आपके कॉलबैक URL पर पोस्ट करता है। यह कॉलबैक डिज़ाइन से ही हस्ताक्षररहित है, इसलिए इस खोज सूचना के लिए आपको webhook सीक्रेट कॉन्फ़िगर करने की ज़रूरत नहीं है। देखें खोज कॉलबैक payload का उदाहरण। सही kyb_response_id चुनने के बाद, शुल्क-योग्य रजिस्ट्री प्रोफ़ाइल को आपको जिस स्तर की ज़रूरत है उस पर प्राप्त करने के लिए POST /v3/kyb/select/ (Lite), POST /v3/kyb/shareholders/ या POST /v3/kyb/ubo/ कॉल करें।
हर उम्मीदवार का fetch_status खोज के समय pending होता है, और जब तक आप उस उम्मीदवार का चयन नहीं करते तब तक pending ही रहता है। खोज केवल उम्मीदवारों की सूची देती है, और पूरी प्रोफ़ाइल चयन करने पर ही प्राप्त होती है। उसके हल होने की प्रतीक्षा में खोज को बार-बार न जाँचें।kyb_response_id एक अपारदर्शी, अस्थायी हैंडल है जो एक खोज अनुरोध तक सीमित है: इसे जैसा प्राप्त हुआ वैसा ही वापस भेजें, इसकी सामग्री को कभी पार्स न करें और उससे कुछ न निकालें, और यह अपेक्षा रखें कि वही खोज दोबारा करने पर नई ids मिलेंगी। खोज के बाद उम्मीदवार को शीघ्र चुनें, और कंपनी की स्थायी पहचान के लिए जब भी ज़रूरत हो registration_number का उपयोग करें।

खोज स्तर

tier यह चुनता है कि खोज किस रजिस्ट्री स्तर की प्रदाता श्रृंखला पर चले: basic (डिफ़ॉल्ट, Lite श्रृंखला), shareholders या ubo। उम्मीदवार सूची उसी स्तर की श्रृंखला से आती है, और Lite खोज हमेशा उसी स्रोत से नहीं पढ़ती। इसलिए खाली Lite खोज यह साबित नहीं करती कि रजिस्ट्री में कंपनी नहीं है। जिस स्तर की आपको ज़रूरत है, उस पर फिर से खोजें। जहाँ देश वह स्तर नहीं देता जिसका आप नाम लेते हैं, वहाँ खोज उस स्तर तक का सबसे ऊँचा स्तर चलाती है जिसे देश देता है। जिस देश में कोई भी रजिस्ट्री डेटा नहीं है, वह रजिस्ट्री जाँच के लिए उपलब्ध नहीं है; मैन्युअल कंपनी प्रविष्टि के साथ जारी रखें। उस स्तर पर खोजें जिसे आप खरीदना चाहते हैं, फिर उम्मीदवार को उस endpoint से प्राप्त करें जो उसे बेचता है:

search_type

search_type केवल contains स्वीकार करता है, और यही डिफ़ॉल्ट है। जिन रजिस्ट्री स्रोतों पर खोज आधारित है, वे कंपनी के नाम का मिलान नाम में शामिल होने के आधार पर करते हैं। इसलिए start_with और fuzzy को 400 ("start_with" is not a valid choice) के साथ अस्वीकार किया जाता है, न कि चुपचाप contains मान लिया जाता है। सटीक कंपनी मिलान के लिए registration_number भेजें।

होस्टेड और स्टैंडअलोन खोज

POST /v1/kyb/search/ वह खोज है जिसे होस्टेड सत्यापन प्रवाह चलाता है। यह सत्यापन सत्र द्वारा प्रमाणित होती है और API कुंजी से किए गए अनुरोध पर 403 लौटाती है, और tier नहीं लेती। वर्कफ़्लो का KYB रजिस्ट्री कॉन्फ़िगरेशन श्रृंखला चुनता है। स्टैंडअलोन API अपनी x-api-key के साथ POST /v2/kyb/search/ या POST /v3/kyb/search/ कॉल करता है। tier इनपुट और स्तर-आधारित select endpoints वे माध्यम हैं जिनसे स्टैंडअलोन इंटीग्रेशन उन्हीं उम्मीदवारों तक, अपनी ज़रूरत के स्तर पर, पहुँचता है।

रजिस्ट्री आउटेज को संभालना

यदि रजिस्ट्री प्रदाता अस्थायी रूप से उपलब्ध नहीं है, तो endpoint एक स्थिर, मशीन-पठनीय कोड के साथ 502 लौटाता है:
यह कोड मिलने पर उपयोगकर्ता को मैन्युअल कंपनी प्रविष्टि के साथ जारी रखने दें, या उनसे बाद में पुनः प्रयास करने को कहें। सत्यापन त्रुटियों को अलग रखें: अमान्य खोज इनपुट 400 लौटाता है और इस आउटेज कोड का उपयोग नहीं करता।

असमर्थित देशों और खोज सीमाओं को संभालना

दो और स्थिर कोड बताते हैं कि पुनः प्रयास रोकें और मैन्युअल कंपनी प्रविष्टि के साथ जारी रखें: होस्टेड प्रवाह में, हर रजिस्ट्री चरण में भुगतान वाले कंपनी-डेटा स्रोत पर 3 खोजें अनुमत हैं। तीसरी के बाद आवेदक को मैन्युअल प्रविष्टि का विकल्प दिया जाता है। ऐसा उम्मीदवार चुनना जो कंपनी नहीं, बल्कि ट्रेडमार्क पंजीकरण है, 400 लौटाता है, जिसमें code: "kyb_registry_entry_not_a_company" होता है। इसके बजाय खोज परिणामों में से कोई कंपनी चुनें।

प्राधिकरण

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
country_code
string
आवश्यक

उस देश का ISO 3166-1 alpha-2 कोड जिसकी कंपनी रजिस्ट्री में खोज करनी है। उदाहरण के लिए, GB। जहाँ कंपनी रजिस्ट्रियाँ राज्य या प्रांत स्तर पर संचालित होती हैं, वहाँ ISO 3166-2 सबडिवीजन कोड को XX-YY के रूप में जोड़ें: US-CA कैलिफ़ोर्निया रजिस्ट्री में खोज करता है। संयुक्त राज्य अमेरिका की खोजों के लिए हमेशा सबडिवीजन की आवश्यकता होती है — केवल US को अस्वीकार कर दिया जाता है। केस-असंवेदी; अपरकेस में सामान्यीकृत किया जाता है।

Maximum string length: 10
उदाहरण:

"GB"

name
string

खोजने के लिए कंपनी का नाम। या तो name या registration_number आवश्यक है।

Maximum string length: 255
उदाहरण:

"Tesco"

registration_number
string

खोजने के लिए रजिस्ट्री पंजीकरण संख्या। name या registration_number में से कोई एक आवश्यक है।

Maximum string length: 100
tier
enum<string>
डिफ़ॉल्ट:basic

रजिस्ट्री स्तर जिसकी प्रदाता श्रृंखला पर यह खोज चलती है। basic (डिफ़ॉल्ट) देश की Lite श्रृंखला को खोजता है; shareholders और ubo उस स्तर की स्वामित्व श्रृंखला को खोजते हैं, जो एक अलग स्रोत हो सकता है, इसलिए खाली Lite खोज यह साबित नहीं करती कि रजिस्ट्री में कंपनी मौजूद नहीं है। जिस देश में नामित स्तर की सुविधा नहीं है, वहां उस स्तर तक उपलब्ध उच्चतम स्तर पर खोज की जाती है। उस endpoint से उम्मीदवार को पुनः प्राप्त करें जो आपके द्वारा खोजे गए स्तर को बेचता है: POST /v3/kyb/select/ (Lite), POST /v3/kyb/shareholders/ या POST /v3/kyb/ubo/।

उपलब्ध विकल्प:
basic,
shareholders,
ubo
उदाहरण:

"basic"

search_type
enum<string>
डिफ़ॉल्ट:contains

रजिस्ट्री खोज द्वारा लागू नाम-मिलान रणनीति। contains एकमात्र स्वीकृत मान है: खोज के पीछे कोई भी रजिस्ट्री स्रोत प्रीफ़िक्स या फ़ज़ी मोड प्रदान नहीं करता है, इसलिए start_with और fuzzy को 400 (not a valid choice) के साथ अस्वीकार कर दिया जाता है।

उपलब्ध विकल्प:
contains
vendor_data
string

इस लुकअप के लिए आपका पहचानकर्ता; वापस दोहराया जाता है और webhook कॉलबैक में शामिल किया जाता है।

metadata
object | null

फ़्री-फ़ॉर्म JSON; वापस लौटाया गया और webhook कॉलबैक में शामिल किया गया।

webhook_url
string<uri>

खोज को एसिंक्रोनस मोड में स्विच करता है: API तुरंत रिस्पॉन्स देता है और उम्मीदवारों की सूची तैयार होने पर इस URL पर एक अनहस्ताक्षरित kyb.registry_search.resolved कॉलबैक POST करता है।

Maximum string length: 500

प्रतिक्रिया

खोज स्वीकार कर ली गई। सिंक्रोनस मोड हल की गई उम्मीदवार सूची लौटाता है; webhook मोड तुरंत रिस्पॉन्स देता है (अक्सर search_status: "pending") और kyb.registry_search.resolved कॉलबैक के माध्यम से अंतिम सूची डिलीवर करता है।

request_id
string<uuid>

webhook_url के साथ: स्थायी रूप से संग्रहीत खोज-अनुरोध ID, जो kyb.registry_search.resolved कॉलबैक में request_id के रूप में दोहराई जाती है। webhook_url के बिना: एक अस्थायी कोरिलेशन UUID (खोज संग्रहीत नहीं की जाती है)।

kyb_registry
object
vendor_data
string | null

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

metadata
object | null

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

created_at
string<date-time>
अंतिम संशोधन 7 नवंबर 2026