मुख्य सामग्री पर जाएं
GET
curl

अवलोकन

vendor_data से पहचाने गए एक व्यवसाय इकाई की जानकारी लौटाता है।

इसे कब उपयोग करें

  • किसी व्यवसाय की मौजूदा सत्यापन स्थिति देखने के लिए जांच करें। features मैप आपको हर KYB फ़ीचर की नवीनतम स्थिति एक नज़र में देता है।
  • आपके अपने एडमिन UI में विवरण दृश्य।
  • एकत्रित काउंटर और फ़ीचर स्थितियों का उपयोग करते हुए जोखिम स्कोरिंग।

नोट्स

  • URL में vendor_data केस-संवेदी है।
  • यदि vendor_data वाला कोई व्यवसाय मौजूद नहीं है, तो 404 लौटाता है।
  • session_count, approved_count, declined_count और in_review_count वाले एकत्रित काउंटर, व्यवसाय सत्यापन (KYB) सत्र पूरे होते ही वास्तविक समय में अपडेट होते हैं।
  • रजिस्ट्री से लिए गए फ़ील्ड legal_name, registration_number और country_code, नवीनतम स्वीकृत व्यवसाय सत्यापन (KYB) सत्र को दर्शाते हैं।

अनुमतियाँ

भूमिका को read:businesses देनी होगी।

संबंधित

प्राधिकरण

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।

पथ पैरामीटर

vendor_data
string
आवश्यक

व्यवसाय के लिए आपका विशिष्ट पहचानकर्ता — एक मुक्त-रूप स्ट्रिंग (UUID नहीं), ठीक वैसे ही मिलान किया गया जैसा भेजा गया था।

प्रतिक्रिया

मेटाडेटा और एकत्रित सत्र डेटा सहित पूर्ण व्यवसाय विवरण।

पूर्ण व्यवसाय विवरण। मेटाडेटा और updated_at के साथ BusinessListItem का विस्तार करता है।

didit_internal_id
string<uuid>

इस व्यवसाय के लिए Didit का स्थायी आंतरिक UUID।

vendor_data
string | null

इस व्यवसाय के लिए आपका विशिष्ट पहचानकर्ता (सत्र बनाते समय पास किया गया)। जब कोई वेंडर पहचानकर्ता प्रदान नहीं किया गया था, तो यह null हो सकता है।

display_name
string | null

आपके द्वारा सेट किया गया कस्टम प्रदर्शन नाम

रजिस्ट्री या मैन्युअल प्रविष्टि से आधिकारिक कानूनी नाम

registration_number
string | null

कंपनी पंजीकरण या निगमन संख्या

country_code
string | null

निगमन का देश (ISO 3166-1 alpha-2, उदा. GB, US)।

effective_name
string | null

सर्वोत्तम उपलब्ध नाम: यदि सेट है तो display_name, अन्यथा legal_name

status
enum<string>

व्यवसाय रिकॉर्ड की लाइफ़साइकिल स्थिति (सत्र स्थिति नहीं)। ACTIVE डिफ़ॉल्ट है, FLAGGED इसे मैन्युअल ध्यान के लिए चिह्नित करता है, BLOCKED इस vendor_data के लिए नए सत्रों को रोकता है।

उपलब्ध विकल्प:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

इस व्यवसाय के लिए सत्यापन सत्रों की कुल संख्या

approved_count
integer

स्वीकृत सत्रों की संख्या

declined_count
integer

अस्वीकृत सत्रों की संख्या

in_review_count
integer

समीक्षाधीन सत्रों की संख्या

features
object

इस व्यवसाय के सभी KYB सत्रों में प्रति-सुविधा एकत्रित स्थिति। वर्तमान में एकमात्र कुंजी KYB (रजिस्ट्री कंपनी जाँच स्थिति) है। संभावित मान: Approved, Declined, In Review, Not Finished, Resub Requested।

features_list
object[]

features जैसा ही डेटा, {feature, status} ऑब्जेक्ट्स के एक क्रमबद्ध ऐरे के रूप में।

last_session_at
string<date-time> | null

सबसे हाल के सत्र का टाइमस्टैम्प

first_session_at
string<date-time> | null

पहले सत्र का टाइमस्टैम्प

last_activity_at
string<date-time> | null

सबसे हाल की गतिविधि का टाइमस्टैम्प (स्थिति परिवर्तन, सत्र अपडेट, आदि)

tags
object[]

इस व्यवसाय को असाइन किए गए टैग

created_at
string<date-time>
metadata
object

कस्टम मेटाडेटा JSON जिसे आपने इस व्यवसाय से जोड़ा है। डिफ़ॉल्ट {} है।

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