मुख्य सामग्री पर जाएं
GET
curl
हर प्रयास लॉग किया जाता है, जिसमें वे स्वचालित पुनः प्रयास भी शामिल हैं जो Didit 5xx या 404 उत्तर के बाद करता है। इसलिए विफल डिलीवरी और उसके बाद का सफल पुनः प्रयास दो प्रविष्टियों के रूप में दिखाई देते हैं, जिनमें request_body के अंदर एक ही event_id होता है। किसी एक डिलीवरी की जाँच करने के लिए, सत्र webhook डिलीवरी प्राप्त करें का उपयोग करें। अपना endpoint ठीक करने के बाद उसे दोबारा भेजने के लिए, सत्र webhook डिलीवरी फिर से भेजें का उपयोग करें।

प्राधिकरण

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।

पथ पैरामीटर

sessionId
string<uuid>
आवश्यक

सत्यापन सत्र का UUID, उपयोगकर्ता (KYC) या व्यवसाय (KYB): POST /v3/session/ द्वारा लौटाया गया session_id। सर्वर इसे दोनों सत्र प्रकारों में रिज़ॉल्व करता है।

एक मान्य UUID होना चाहिए। यह रूट केवल सही प्रारूप वाले UUID से मेल खाता है, इसलिए किसी भी एप्लिकेशन कोड के चलने से पहले URL राउटर द्वारा गलत प्रारूप वाले मान को अस्वीकार कर दिया जाता है और रिस्पॉन्स नीचे दिखाए गए JSON {"detail": ...} एनवलप के बजाय 404 HTML पेज होता है।

प्रतिक्रिया

सत्र के लिए रिकॉर्ड की गई प्रत्येक डिलीवरी, सबसे नई पहले।

uuid
string<uuid>
आवश्यक

डिलीवरी ID। इस डिलीवरी को प्राप्त करने या पुनः भेजने के लिए इसे {webhook_uuid} के रूप में उपयोग करें।

session_id
string<uuid>
आवश्यक

वह सत्र जिससे डिलीवरी संबंधित है (पाथ में दिया गया सत्र)।

request_url
string<uri> | null
आवश्यक

वह URL जिस पर डिलीवरी भेजी गई थी।

response_status
integer | null
आवश्यक

आपके endpoint द्वारा लौटाया गया HTTP स्टेटस। जब डिलीवरी कतार में हो और अभी तक प्रयास न किया गया हो तो null। जब कोई HTTP उत्तर प्राप्त नहीं हुआ, तो Didit अपनी स्वयं की स्थिति दर्ज करता है: जब आपके endpoint ने 5 सेकंड के भीतर उत्तर नहीं दिया तो 504, कनेक्शन विफलता के लिए 503, जब URL को असुरक्षित (उदाहरण के लिए एक निजी या आंतरिक पता) के रूप में अस्वीकार कर दिया गया था तो 400, और किसी भी अन्य अनुरोध त्रुटि के लिए 404। 400 या उससे अधिक को विफल डिलीवरी माना जाता है।

status
string | null
आवश्यक

इवेंट जनरेट होने पर सत्र की स्थिति, उदाहरण के लिए In Progress, Approved या Declined।

webhook_type
enum<string>
आवश्यक

समर्थित webhook इवेंट का नाम। subscribed_events में इन सटीक स्ट्रिंग्स का उपयोग करें; असमर्थित मान अस्वीकृत कर दिए जाते हैं।

उपलब्ध विकल्प:
status.updated,
data.updated,
user.status.updated,
user.data.updated,
business.status.updated,
business.data.updated,
activity.created,
transaction.created,
transaction.status.updated,
travel_rule.status.updated,
workflow.compliance_changed,
transaction_rule_suggestions.created,
auth.signup,
auth.login,
auth.login_failed,
auth.password_reset_requested,
auth.password_reset_completed,
auth.mfa_changed,
auth.new_device,
auth.account_locked,
investigator.report.ready,
investigator.decision.automated,
investigator.decision.overridden,
investigator.decision.contested,
investigator.question.raised,
investigator.automation.paused,
investigator.rfi.answered,
investigator.rfi.overdue,
investigator.drift.detected,
investigator.sla.breached,
investigator.qa.failed,
investigator.external.report.ready
request_header
string
आवश्यक

Didit द्वारा भेजे गए अनुरोध हेडर का JSON टेक्स्ट (एक स्ट्रिंग): Content-Type, X-Signature, X-Signature-V2, X-Signature-Simple, X-Timestamp और User-Agent। इसे JSON पार्सर से पार्स करें। इसमें हस्ताक्षर होते हैं, लेकिन साइनिंग सीक्रेट कभी नहीं होता।

request_body
string
आवश्यक

Didit द्वारा भेजे गए सटीक payload का JSON टेक्स्ट (एक स्ट्रिंग), कुंजियाँ सॉर्ट की गई हैं, जिसमें event_id और timestamp शामिल हैं। इसे JSON पार्सर से पार्स करें; Payload shape देखें। बिना media: read वाली स्कोप्ड कुंजी के लिए, इसके अंदर मीडिया URL null होते हैं; बिना sessions: write के, सत्र token और होस्टेड सत्यापन लिंक null होते हैं। इस तरह बदली गई बॉडी अब अपने हस्ताक्षरों से मेल नहीं खाती है। Didit आपके endpoint द्वारा लौटाए गए रिस्पॉन्स बॉडी को रिकॉर्ड नहीं करता है।

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

जब डिलीवरी बनाई गई थी।

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