चारों endpoints आपकी क्लाइंट API कुंजी या उपयोगकर्ता प्राधिकरण हेडर स्वीकार करते हैं, और सफल होने पर सभी एक
data.updated webhook भेजते हैं, ताकि आपका सिस्टम और डाउनस्ट्रीम विश्लेषण सिंक में रहें।
साझा आवश्यकताएँ
- प्राधिकरण: क्लाइंट API कुंजी (मानक
x-api-key/Authorizationbearer) या उपयोगकर्ता token। - विशेषाधिकार:
- KYC और POA:
write:sessions - KYB कंपनी और प्रमुख व्यक्ति पार्टी:
write:businesses
- KYC और POA:
- सत्र की स्थिति (केवल KYC / POA): इनमें से एक होनी चाहिए:
APPROVED,DECLINED,IN_REVIEW, याKYC_EXPIRED। जो सत्र समीक्षा योग्य स्थिति तक नहीं पहुँचे हैं, उन्हें patch नहीं किया जा सकता। KYB कंपनी अपडेट पर कोई स्थिति प्रतिबंध नहीं है। - सुविधा रिकॉर्ड मौजूद होना चाहिए: KYC फ़ील्ड केवल तभी patch कर सकते हैं जब सत्र में KYC कैप्चर किया गया हो, POA फ़ील्ड केवल तभी जब POA कैप्चर किया गया हो, और KYB कंपनी फ़ील्ड केवल तभी जब सत्र में रजिस्ट्री जाँच हो।
- आंशिक अपडेट: केवल वही फ़ील्ड बदले जाते हैं जो आप शामिल करते हैं। किसी फ़ील्ड को छोड़ने पर वह जैसा है वैसा ही रहता है।
extra_fieldsकी किसी key को हटाने के लिएnullभेजें। - Webhooks: सफल अपडेट पर
session_kind: "user"या"business"के साथdata.updatedभेजा जाता है, और सत्र का audit trail यह दर्ज करता है कि कौन से विशिष्ट फ़ील्ड बदले गए और किसने बदले।
KYC पहचान डेटा अपडेट करें
PATCH /v3/session/{sessionId}/update-data/
ID दस्तावेज़ से निकाला गया कोई भी फ़ील्ड patch करें। यह ग्राफ़-आधारित मल्टी-इंस्टेंस वर्कफ़्लो को सपोर्ट करता है: जब एक सत्र में कई KYC चरण हों, तो वैकल्पिक node_id query parameter या body field के ज़रिए एक विशिष्ट KYC रिकॉर्ड चुनें।
बदलने योग्य फ़ील्ड
parsed_address केवल ये nested keys स्वीकार करता है: address_type, city, region, street_1, street_2, postal_code, country (ISO 3166-1 alpha-2)।
उदाहरण
?node_id=feature_ocr_2 जोड़ें (या body में "node_id": "feature_ocr_2" भेजें) ताकि एक विशिष्ट KYC रिकॉर्ड चुना जा सके।
पते का प्रमाण (POA) डेटा अपडेट करें
PATCH /v3/session/{sessionId}/update-poa-data/
पते के प्रमाण वाले दस्तावेज़ से निकाले गए फ़ील्ड patch करें। इसके लिए वही सत्र स्थिति प्रतिबंध और अनुमति लागू होती है जो KYC अपडेट पर है। यह मल्टी-इंस्टेंस वर्कफ़्लो के लिए node_id भी स्वीकार करता है।
बदलने योग्य फ़ील्ड
उदाहरण
KYB कंपनी डेटा अपडेट करें
PATCH /v3/session/{sessionId}/kyb/{companyUuid}/update-data/
KYB कंपनी में रजिस्ट्री से निकाले गए फ़ील्ड्स में सुधार करें। यह endpoint कैनोनिकल कंपनी कॉलम और registry_data दोनों को संपादित करता है, ताकि कंसोल का “Extracted from Registry” व्यू आपके सुधार दिखाए। user_provided_data (जिसकी पुष्टि अंतिम उपयोगकर्ता ने होस्टेड फ़्लो में की थी) में बदलाव नहीं होता। last_console_edit_at सेट किया जाता है, और trigger: "console_registry_edit" के साथ data.updated webhook फ़ायर होता है।
आवश्यकताएँ
- विशेषाधिकार -
write:businesses(KYC / POA विशेषाधिकार से अलग)। - URL में दिया गया
companyUuidदिए गएsessionIdसे संबंधित होना चाहिए, अन्यथा आपको 404 मिलेगा। - सत्र की स्थिति पर कोई रोक नहीं है। KYB कंपनी डेटा किसी भी समय सुधारा जा सकता है।
परिवर्तनीय फ़ील्ड्स
आप जो फ़ील्ड छोड़ते हैं, वह अपरिवर्तित रहता है। आप जो फ़ील्ड भेजते हैं, वह (यदि कैनोनिकल कॉलम मौजूद है) उस कॉलम में लिखा जाता है और
registry_data में मर्ज किया जाता है। registry_data में मर्ज करते समय तिथियाँ ISO 8601 स्ट्रिंग के रूप में सीरियलाइज़ की जाती हैं।
उदाहरण
registry_checks[].company जैसा ही है।
प्रमुख व्यक्ति पक्ष को छोड़ें
PATCH /v3/session/{sessionId}/kyb/parties/{partyUuid}/
किसी प्रमुख व्यक्ति पक्ष को सत्यापन से छूट दें। यह उस पक्ष के लिए आपात मार्ग है जो अपनी जाँच कभी पूरी नहीं कर सकता। आम कारण हटाया गया child session होता है: एक बार UBO या निदेशक को सौंपा गया व्यक्तिगत KYC हटा दिया जाए, तो उसकी स्थिति स्थिर हो जाती है और वह कभी तय नहीं हो सकती। इसलिए KYB के पास ऐसा कुछ नहीं बचता जो उसे Awaiting User से बाहर निकाल सके। पक्ष को छोड़ने पर वह प्रमुख व्यक्ति एकत्रीकरण से बाहर हो जाता है, जाँच तुरंत पुनः गणना होती है, और सत्र का निपटारा होकर वह स्वीकृत या अस्वीकृत हो सकता है।
आवश्यकताएँ
- विशेषाधिकार -
write:businesses। - URL में दिया गया
partyUuidदिए गएsessionIdसे संबंधित होना चाहिए, अन्यथा आपको 404 मिलेगा। allow_skipसे नियंत्रित नहीं। वह भूमिका सेटिंग सीमित करती है कि आवेदक होस्टेड प्रमुख व्यक्ति स्क्रीन भरते समय क्या छोड़ सकता है। यह endpoint ऑपरेटर का ओवरराइड है, इसलिए यह उन भूमिकाओं पर भी काम करता है जिन्हें आवेदक नहीं छोड़ सकता था।
बॉडी
requires_verification जानबूझकर अपरिवर्तित छोड़ा जाता है, इसलिए ओवरराइड किए गए पक्ष में requires_verification: true और is_skipped: true दिखता है। इससे रिकॉर्ड में यह दिखता रहता है कि नियमों ने जाँच माँगी थी।
उदाहरण
key_people_checks[].submitted.parties[] की एक प्रविष्टि जैसा ही है।
trigger: "console_key_people_skip" के साथ data.updated webhook फ़ायर होता है।
जिस पक्ष का child session हटाया गया था, उसे निर्णय payload में
kyc_session_deleted: true (या कॉर्पोरेट पक्षों के लिए kyb_sub_session_deleted: true) से चिह्नित किया जाता है,
और उसका kyc_session_url / kyb_sub_session_url null लौटाया जाता है, क्योंकि लिंक अब काम नहीं करता। child session हटाने से
पक्ष अपने आप स्वीकृत नहीं होता। प्रमुख व्यक्ति जाँच In Review पर आ जाती है, ताकि निर्णय कोई व्यक्ति ले।अपडेट के बाद क्या होता है
- webhook - सत्र पर
data.updatedफ़ायर होता है, और payload में सत्र काsession_kind("user"या"business") होता है। गंतव्य स्तर पर एक बार सदस्यता लें औरsession_kindके आधार पर रूट करें। - ऑडिट रिकॉर्ड - सत्र में ठीक-ठीक यह दर्ज होता है कि कौन से फ़ील्ड बदले, पिछले और नए मान क्या थे, और (उपयोगकर्ता-प्रमाणीकरण कॉल के लिए) अभिकर्ता का ईमेल। यह कंसोल के Events टैब में दिखता है।
- पता पुनः जियोकोडिंग - KYC और POA अपडेट में जब
address/poa_addressबदलते हैं, तो Didit पृष्ठभूमि में जियोकोडिंग दोबारा चलाता है। विफलताएँ अनदेखी की जाती हैं, ताकि जियोकोडिंग समस्या से अपडेट कभी विफल न हो। - AML पुनर्मूल्यांकन - जिन KYC अपडेट में नाम / जन्म तिथि / राष्ट्रीयता बदलते हैं, वे AML स्क्रीनिंग फिर से शुरू कर सकते हैं, यदि सत्र पर AML पूरा नहीं हुआ था। परिणाम सत्र निर्णय पर दिखते हैं।
इन endpoints का उपयोग कब न करें
- पूरी सत्यापन प्रक्रिया दोबारा चलाना - यदि ग्राहक को अपनी ID की फ़ोटो दोबारा लेनी है या दस्तावेज़ फिर से अपलोड करना है, तो सत्र को
Resubmittedपर ले जाने के लिए update-status का उपयोग करें। - User या Business entity के प्रोफ़ाइल फ़ील्ड बदलना -
PATCH /v3/users/{vendor_data}/याPATCH /v3/businesses/{vendor_data}/का उपयोग करें। ये endpoints entity-स्तर का डेटा अपडेट करते हैं, सत्र-स्तर का नहीं। - प्रमुख व्यक्ति का विवरण संपादित करना - किसी पक्ष का नाम, भूमिकाएँ या स्वामित्व पैच करने के लिए कोई सार्वजनिक API नहीं है। यह डेटा होस्टेड फ़्लो के माध्यम से जमा किया जाता है। एकमात्र पैच योग्य फ़ील्ड
is_skippedहै (देखें प्रमुख व्यक्ति पक्ष को छोड़ें)।
त्रुटियाँ
आगे के चरण
सत्र प्राप्त करें
अपडेट किए गए फ़ील्ड देखने के लिए पूरा निर्णय प्राप्त करें।
स्टेटस अपडेट करें
डेटा सुधार के बाद सत्र को स्वीकृत करें, अस्वीकृत करें, या फिर से खोलें।
webhook
data.updated webhook इवेंट की सदस्यता लें।