मुख्य सामग्री पर जाएं
GET
curl
यह endpoint उस एप्लिकेशन-स्तरीय webhook को लौटाता है जो गंतव्यों के अस्तित्व में आने से पहले मौजूद था, साथ ही गंतव्यों की सूची भी देता है। Didit आपके webhook गंतव्यों पर webhook भेजता है, और हर गंतव्य पर उसकी अपनी secret_shared_key से हस्ताक्षर किया जाता है। शीर्ष स्तर के webhook_url, webhook_version और secret_shared_key केवल तब इस्तेमाल होते हैं जब कोई गंतव्य सक्रिय नहीं होता, और तब भी केवल status.updated और data.updated के लिए।
रिस्पॉन्स में आपके एप्लिकेशन के सभी साइनिंग सीक्रेट शामिल होते हैं। इन्हें लॉग में और क्लाइंट-साइड कोड में न रखें।
इन सेटिंग्स को बदलने के लिए, webhook कॉन्फ़िगरेशन अपडेट करें का उपयोग करें। हस्ताक्षर सत्यापन और payloads के लिए, 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।

प्रतिक्रिया

webhook कॉन्फ़िगरेशन।

प्रत्येक webhook गंतव्य के साथ एप्लिकेशन-स्तरीय webhook कॉन्फ़िगरेशन, प्रतिधारण नीति और Digital ID वॉलेट रिटर्न होस्ट।

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

एप्लिकेशन-स्तरीय (लीगेसी) webhook URL। Didit इस पर केवल तभी भेजता है जब एप्लिकेशन के पास कोई सक्षम गंतव्य न हो, और फिर केवल status.updated और data.updated। किसी गंतव्य का प्रत्येक निर्माण, अपडेट या विलोपन इसे सबसे पुराने सक्षम गंतव्य के URL पर सेट करता है, या सक्षम न होने पर null पर।

webhook_version
enum<string>
आवश्यक

लेगसी webhook_url का payload संस्करण। प्रत्येक गंतव्य का अपना webhook_version होता है।

उपलब्ध विकल्प:
v1,
v2,
v3
secret_shared_key
string
आवश्यक

एप्लिकेशन-स्तरीय साइनिंग सीक्रेट (43-वर्णों वाला URL-सुरक्षित token)। यह केवल लीगेसी webhook_url पर डिलीवरी पर हस्ताक्षर करता है; प्रत्येक गंतव्य अपनी secret_shared_key से हस्ताक्षर करता है। API कुंजी का उपयोग करने वाले कॉलकर्ताओं को यह हमेशा पूरी तरह से प्राप्त होता है; बिना read:webhooks वाले कंसोल उपयोगकर्ताओं को एक खाली स्ट्रिंग प्राप्त होती है।

capture_method
enum<string>
आवश्यक

लीगेसी एप्लिकेशन सेटिंग। सत्यापन फ़्लो इसे नहीं पढ़ता है: कैप्चर विकल्प प्रति वर्कफ़्लो कॉन्फ़िगर किए जाते हैं।

उपलब्ध विकल्प:
MOBILE,
MOBILE_AND_DESKTOP
data_retention_months
integer | null
आवश्यक

स्वचालित विलोपन विंडो। इस संख्या से अधिक महीने पहले बनाए गए उपयोगकर्ता सत्यापन सत्र (एक महीने को 30 दिन गिना जाता है) स्वचालित रूप से हटा दिए जाते हैं, और यह विलोपन अपरिवर्तनीय होता है। null का अर्थ है कि सत्र कभी भी स्वचालित रूप से नहीं हटाए जाते हैं। देखें डेटा प्रतिधारण।

आवश्यक सीमा: 1 <= x <= 120
face_retention_policy
enum<string>
आवश्यक

सत्र हटाए जाने पर सत्र के फ़ेस एम्बेडिंग का क्या होता है। delete_with_session (डिफ़ॉल्ट) इसे सत्र के साथ हटा देता है। retain_until_user_deleted ऑप्ट-इन बायोमेट्रिक टेम्पलेट प्रतिधारण है: उपयोगकर्ता से जुड़ा एक छवि-मुक्त बायोमेट्रिक टेम्पलेट तब तक अलग से प्रबंधित किया जाता है जब तक कि इसकी प्रतिधारण अवधि समाप्त न हो जाए, उपयोगकर्ता हटा न दिया जाए, या आप इसे पर्ज न कर दें।

उपलब्ध विकल्प:
delete_with_session,
retain_until_user_deleted
face_retention_days
integer | null
आवश्यक

retain_until_user_deleted के तहत बायोमेट्रिक टेम्पलेट्स की डेटा प्रतिधारण अवधि, दिनों में। यह नीति सेट होने पर आवश्यक है।

आवश्यक सीमा: 1 <= x <= 3650
available_events
object[]
आवश्यक

प्रत्येक इवेंट प्रकार जिसे एक गंतव्य सब्सक्राइब कर सकता है, एक डिस्प्ले लेबल के साथ।

allowed_return_hosts
string[]
आवश्यक

होस्टनाम (सटीक मिलान, केवल HTTPS) जिन पर स्टैंडअलोन डिजिटल ID वॉलेट सत्यापन उपयोगकर्ता को अपने return_url के साथ वापस भेज सकता है। आपका व्हाइट लेबल डोमेन भी हमेशा अनुमत है। देखें अपना वापसी गंतव्य पंजीकृत करें।

Maximum array length: 20
Maximum string length: 253
endpoints
object[]
आवश्यक

एप्लिकेशन का प्रत्येक webhook गंतव्य, सबसे पुराना पहले, प्रत्येक अपने हस्ताक्षर सीक्रेट के साथ। यहाँ केवल पढ़ने के लिए: /v3/webhook/destinations/ endpoints के साथ गंतव्यों का प्रबंधन करें।

होस्टेड फ़्लो और नेटिव SDK चेहरा कैप्चर करने से पहले व्यक्ति से स्पष्ट बायोमेट्रिक सहमति कब मांगते हैं। auto (डिफ़ॉल्ट) केवल तभी पूछता है जब कोई ट्रिगर लागू होता है: घोषित राज्य, व्यक्ति का IP, या पहचान दस्तावेज़ का जारीकर्ता Illinois, Texas या Colorado में हो, या व्यक्ति US में प्रतीत होता हो, लेकिन राज्य ज्ञात न हो। always ऐसे प्रत्येक व्यक्ति से पूछता है जिसके वर्कफ़्लो में चेहरा कैप्चर किया जाता है। never कभी भी यह चरण नहीं दिखाता है, और आप सेल्फ़ी से पहले सहमति स्वयं एकत्र करते हैं। प्रत्येक परिवर्तन ऑडिट लॉग में दर्ज किया जाता है। बायोमेट्रिक सहमति देखें।

उपलब्ध विकल्प:
auto,
always,
never
allowed_domains
string[]

ऑरिजिन (उदाहरण के लिए https://app.example.com; केवल localhost के लिए http) जिनमें होस्टेड सत्यापन प्रवाह को एम्बेड किया जा सकता है और जो सत्र कॉलबैक के साथ उपयोगकर्ता को वापस भेज सकते हैं। सर्वर-टू-सर्वर कॉल प्रभावित नहीं होती हैं। एक खाली सूची का अर्थ है कोई प्रतिबंध नहीं। Didit प्रत्येक ऑरिजिन को बिना डिफ़ॉल्ट पोर्ट के लोअरकेस में संग्रहीत करता है। अमान्य प्रविष्टि allowed_domains पर 400 के साथ विफल हो जाती है।

Maximum array length: 50
Maximum string length: 300
उदाहरण:
अंतिम संशोधन 7 नवंबर 2026