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

अवलोकन

व्यवसाय इकाई के बदले जा सकने वाले फ़ील्ड अपडेट करता है। रजिस्ट्री लुकअप से भरे गए फ़ील्ड (legal_name, registration_number, country_code) पहले स्वीकृत व्यवसाय सत्यापन (KYB) सत्र के बाद केवल-पठन हो जाते हैं।

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

  • नाम बदलें: आंतरिक व्यू के लिए बेहतर display_name सेट करें।
  • मेटाडेटा अपडेट करें: किसी व्यवसाय को आंतरिक स्तरों के बीच ले जाएं, आंतरिक नोट दर्ज करें, या टैग बदलें।
  • रजिस्ट्री डेटा ओवरराइड करें (सावधानी के साथ): ओवरराइड स्वीकार किए जाते हैं, लेकिन ऑडिट लॉग में चिह्नित किए जाते हैं।

नोट्स

  • URL में vendor_data को इस endpoint से नहीं बदला जा सकता।
  • changed_fields ऐरे के साथ business.data.updated webhook भेजा जाता है।
  • हर संपादन Business Console में कंपनी की गतिविधि में दर्ज होता है। status बदलने पर वैकल्पिक reason (अधिकतम 1000 वर्ण) के साथ दर्ज होता है, और display_name, legal_name, registration_number, country_code या metadata में बदलाव प्रोफ़ाइल अपडेट के रूप में दर्ज होता है। business.status.updated webhook में reason शामिल नहीं होता।

अनुमतियां

मुख्य सीक्रेट और पूर्ण-पहुंच वाली API कुंजियां इस endpoint को हमेशा कॉल कर सकती हैं। कस्टम पहुंच वाली कुंजी को कंपनियों (businesses) के लिए लिखने की अनुमति चाहिए। जो कुंजी केवल कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित है, वह इस endpoint तक नहीं पहुंच सकती। Console की भूमिकाएं और अनुमतियां तय करती हैं कि कोई टीम सदस्य Console में क्या कर सकता है। API कुंजी के अनुरोधों के लिए इनका मूल्यांकन नहीं किया जाता।

संबंधित

प्राधिकरण

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 नहीं)।

बॉडी

application/json

आंशिक-अपडेट बॉडी। केवल वे फ़ील्ड प्रदान करें जिन्हें आप बदलना चाहते हैं।

display_name
string | null

कंसोल में दिखाया जाने वाला मैत्रीपूर्ण डिस्प्ले नाम (UI डिस्प्ले के लिए legal_name पर वरीयता लेता है)।

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

registration_number
string | null

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

country_code
string | null

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

status
enum<string>

व्यवसाय जीवनचक्र स्थिति। BLOCKED सेट करने पर सिस्टम ब्लॉकलिस्ट में vendor_data स्वचालित रूप से जुड़ जाता है; BLOCKED से हटाने पर वह ब्लॉकलिस्ट प्रविष्टि हट जाती है।

उपलब्ध विकल्प:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

व्यवसाय से जुड़ा आपका मनमाना JSON ऑब्जेक्ट। अपडेट करने पर मौजूदा मेटाडेटा को पूरी तरह से बदल देता है — यदि आप केवल कुंजियाँ जोड़ना चाहते हैं तो क्लाइंट-साइड मर्ज करें।

reason
string | null

स्थिति क्यों बदली। Business Console में कंपनी की Activity की स्थिति-परिवर्तन प्रविष्टि पर रिकॉर्ड किया जाता है, केवल तभी जब स्थिति वास्तव में बदलती है। Webhooks इसे शामिल नहीं करते हैं।

Maximum string length: 1000

प्रतिक्रिया

व्यवसाय अपडेट किया गया। पूरा अपडेट किया गया व्यवसाय रिकॉर्ड लौटाया जाता है।

पूर्ण व्यवसाय विवरण। मेटाडेटा और 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