मुख्य सामग्री पर जाएं
POST
curl
नोट संदर्भ के लिए है, निर्णय के लिए नहीं: यह लेन-देन के status, score या अलर्ट को कभी नहीं बदलता। समीक्षक इसे कंसोल में लेन-देन विवरण पर नोट्स के अंतर्गत देखते हैं, और लेन-देन की activities में एक TRANSACTION_NOTE_ADDED प्रविष्टि जुड़ जाती है, जिसे आप लेन-देन प्राप्त करें से पढ़ सकते हैं। चूँकि नोट एक API कुंजी से आता है, इसमें कोई लेखक नहीं होता: actor_email और actor_name null होते हैं। यदि आपको दिखाना है कि इसे किसने लिखा, तो यह जानकारी नोट के टेक्स्ट में शामिल करें। लेन-देन के नोट्स की सूची प्राप्त करें से पूरी टाइमलाइन दोबारा पढ़ें।

प्राधिकरण

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।

पथ पैरामीटर

transaction_id
string<uuid>
आवश्यक

Didit लेन-देन UUID: POST /v3/transactions/ और GET /v3/transactions/ द्वारा लौटाया गया uuid। आपकी अपनी txn_id स्वीकार नहीं की जाती है।

बॉडी

application/json
note
string
आवश्यक

सादा टेक्स्ट नोट। शुरुआत और अंत के रिक्त स्थान को हटा दिया जाता है और खाली नोट को अस्वीकार कर दिया जाता है। कोई लंबाई सीमा नहीं।

Minimum string length: 1
mentioned_emails
string<email>[]

मेंशन करने के लिए आपके संगठन के सदस्यों के ईमेल। प्रत्येक आपके संगठन के सदस्य का एक मान्य ईमेल होना चाहिए।

प्रतिक्रिया

नोट बनाया गया था।

निगरानी किए गए लेन-देन की समीक्षा टाइमलाइन पर एक नोट।

uuid
string<uuid>
आवश्यक

नोट पहचानकर्ता।

note
string
आवश्यक

सादे टेक्स्ट वाले नोट का मुख्य भाग।

actor_email
string<email> | null
आवश्यक

उस कंसोल उपयोगकर्ता का ईमेल जिसने नोट लिखा या स्थिति बदली। API कुंजी से बनाए गए नोटों और Didit द्वारा स्वचालित रूप से जोड़े गए नोटों के लिए null।

actor_name
string | null
आवश्यक

Console उपयोगकर्ता का डिस्प्ले नाम (यदि कोई नाम नहीं है तो उनका ईमेल)। Didit द्वारा स्वचालित रूप से जोड़े गए नोट्स पर Rule Engine। API कुंजी के साथ बनाए गए नोट्स के लिए null।

metadata
object
आवश्यक

नोट के प्रकारों में अंतर बताता है। API या कंसोल के माध्यम से लिखे गए नोटों में mentioned_emails शामिल होता है। कंसोल में किए गए स्थिति परिवर्तन में previous_status, new_status, reason_code और reason_label के साथ type: status_change शामिल होता है। Didit द्वारा जोड़े गए नोटों में source शामिल होता है: किसी नियम की add_note कार्रवाई के लिए rule_action (rule_uuid के साथ), या उपयोगकर्ता-कार्रवाई सत्यापन सत्र बनाने में किसी समस्या के लिए remediation_session।

created_at
string<date-time>
आवश्यक

नोट कब संग्रहीत किया गया था।

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