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

KYC और KYB समर्थन

यह endpoint उपयोगकर्ता सत्यापन (KYC) और व्यवसाय सत्यापन (KYB) सत्रों के लिए बिल्कुल एक जैसे काम करता है। Didit session_id को दोनों प्रकार के सत्रों पर हल करता है; स्थिति-परिवर्तन की जाँच दोनों के लिए समान है (दोनों पर स्थितियों की एक ही सूची लागू होती है)। प्रतिक्रिया में केवल session_id होता है। जब आपके आगे के तर्क को सत्र के प्रकार के आधार पर बदलना हो, तब सत्र प्राप्त करें से session_kind पढ़ें।

अनुमत परिवर्तन

आप किसी सत्र को Approved, Declined, या Resubmitted में बदल सकते हैं। कोई भी अन्य new_status, जिसमें In Review भी शामिल है, 400 लौटाता है। सत्र की वर्तमान स्थिति Approved, Declined, In Review, Kyc Expired, Abandoned, या Resubmitted में से एक होनी चाहिए; अन्यथा API 400 लौटाता है। जो सत्र पहले से वही स्थिति रखता है, उस पर Approved या Declined सेट करने से कुछ नहीं बदलता: API 200 लौटाता है, कुछ नहीं बदलता, कोई webhook नहीं भेजता और कोई ईमेल नहीं भेजता। जो सत्र पहले से Resubmitted पर है, उस पर Resubmitted सेट करने पर 400 लौटता है (The new status is the same as the current status.)। जिस पुनः सबमिशन के nodes_to_resubmit में केवल बैकएंड-only फ़ीचर (AML, DATABASE_VALIDATION, IP_ANALYSIS) हों, वह अपने आप चलता है और उपयोगकर्ता की किसी कार्रवाई के बिना सत्र को किसी निर्णय वाली स्थिति में लौटा देता है। ऐसे पुनः सबमिशन को 30 सेकंड के भीतर दोहराने पर Retry-After हेडर के साथ 429 Too Many Requests लौटता है, क्योंकि तुरंत दोहराने से अलग परिणाम नहीं आ सकता। जब भी आपको In Review स्थिति मिले, webhook हैंडलर से अपने आप पुनः सबमिट न करें: पहले निष्कर्ष की समीक्षा करें या अंतर्निहित डेटा बदलें।

ईमेल का पूर्वावलोकन पहले करें

send_email: true के साथ, Approved और Declined व्यक्ति को उसका निर्णय वाला ईमेल भेजते हैं, और Resubmitted उसे कारणों के साथ एक नया लिंक भेजता है। आप कुछ भी बदलने से पहले वह ईमेल देख सकते हैं:
  1. Approved या Declined के लिए निर्णय ईमेल का पूर्वावलोकन करें, या Resubmitted के लिए पुनः सबमिशन ईमेल का पूर्वावलोकन करें।
  2. प्रस्तुत subject और html, recipient, तथा will_be_sent / not_sent_reason जाँचें।
  3. इस endpoint को उसी new_status के साथ कॉल करें (और पुनः सबमिशन के लिए वही nodes_to_resubmit), साथ में send_email: true, email_address जिसका मान recipient हो, वह email_language जिसका आपने पूर्वावलोकन किया था, और email_preview_token जिसका मान preview_token हो।
कोई भी पूर्वावलोकन सत्र को नहीं बदलता और कुछ नहीं भेजता। अपडेट ठीक वही ईमेल भेजता है जिसका आपने पूर्वावलोकन किया था। रसीद 15 मिनट बाद समाप्त हो जाती है। यदि पूर्वावलोकन के बाद प्राप्तकर्ता, भाषा, सत्र की स्थिति, प्रेषक या ईमेल बदल गया है, तो अपडेट कुछ भी बदलने से पहले 409 लौटाता है; फिर से पूर्वावलोकन करें और नई रसीद के साथ पुष्टि करें। send_email: true के बिना email_preview_token भेजने पर 400 लौटता है। पूर्वावलोकन चरण वैकल्पिक है: मौजूदा इंटीग्रेशन इसके बिना भी इस endpoint को कॉल करते रह सकते हैं।

उदाहरण

अनुमति

इसके लिए write:sessions विशेषाधिकार चाहिए। यही विशेषाधिकार दोनों प्रकारों पर लागू होता है।

संबंधित

प्राधिकरण

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) दोनों सत्र ID स्वीकार करता है — सेवा दोनों सत्र प्रकारों में ID को रिज़ॉल्व करती है।

उदाहरण:

"11111111-2222-3333-4444-555555555555"

बॉडी

application/json
new_status
enum<string>
आवश्यक

लक्षित स्थिति। Approved और Declined एक अंतिम मैन्युअल निर्णय रिकॉर्ड करते हैं (प्रत्येक दूसरे को पलट भी सकता है)। Resubmitted चयनित चरणों को साफ़ करता है और सत्र को वापस उपयोगकर्ता के पास भेज देता है। कोई भी अन्य मान 400 लौटाता है।

उपलब्ध विकल्प:
Approved,
Declined,
Resubmitted
उदाहरण:

"Approved"

comment
string

बदलाव का मुक्त-पाठ कारण, जो सत्र के समीक्षा ट्रेल पर संग्रहीत होता है और Get Decision के reviews ऐरे में लौटाया जाता है। उदाहरण के लिए Duplicated user।

उदाहरण:

"All checks passed manual review"

nodes_to_resubmit
object[]

वर्कफ़्लो चरण जिन्हें उपयोगकर्ता को फिर से करना होगा। केवल तभी कार्रवाई की जाती है जब new_status Resubmitted हो। Approved/Declined के लिए प्रविष्टियाँ अभी भी स्कीमा-सत्यापित होती हैं (एक अमान्य feature मान 400 लौटाता है) लेकिन स्कीमा-वैध प्रविष्टियों को सिमेंटिक रूप से अनदेखा कर दिया जाता है। यदि छोड़ दिया जाता है, तो सर्वर मौजूदा OCR, लाइवनेस, चेहरा मिलान, POA, फ़ोन, ईमेल, AML, डेटाबेस सत्यापन, और प्रश्नावलियाँ प्रयासों का स्वतः चयन करता है जिनकी स्थिति Declined, In Review, Not Finished, या Expired है (NFC, IP विश्लेषण, आयु अनुमान, चेहरा खोज, और KYB दस्तावेज़ प्रयासों का कभी भी स्वतः चयन नहीं किया जाता है; चेहरा मिलान के अलावा वाले चेहरे के प्रयासों को LIVENESS के रूप में चुना जाता है) — वे सुविधाएँ जिनका उपयोगकर्ता ने कभी प्रयास नहीं किया (कोई रिकॉर्ड किया गया प्रयास नहीं) चुनी नहीं जाती हैं, इसलिए शून्य प्रयासों वाला सत्र 400 लौटाता है ("No features found that need resubmission") भले ही कुछ भी स्वीकृत न हुआ हो; उस स्थिति में स्पष्ट रूप से nodes_to_resubmit पास करें। चरण वर्कफ़्लो-ग्राफ़ क्रम में निष्पादित होते हैं, भले ही आप उन्हें किसी भी क्रम में भेजें। KYB_REGISTRY, KYB_KEY_PEOPLE, और KYB उपनाम को 400 के साथ अस्वीकार कर दिया जाता है — वे पैरेंट जाँचें अपने चाइल्ड KYC सत्रों से पुनर्गणना करती हैं।

send_email
boolean
डिफ़ॉल्ट:false

क्या उपयोगकर्ता को इस बदलाव के बारे में ईमेल भेजा जाए। इसके लिए email_address आवश्यक है। Approved/Declined के लिए उपयोगकर्ता को स्थिति सूचना प्राप्त होती है; Resubmitted के लिए ईमेल में सत्यापन लिंक और प्रत्येक चरण के लिए पुनः सबमिशन के कारण शामिल होते हैं।

उदाहरण:

false

email_address
string<email>

अधिसूचना ईमेल के लिए प्राप्तकर्ता। जब send_email true हो तो आवश्यक — इसे छोड़ने पर 400 मिलता है।

उदाहरण:

"user@example.com"

email_language
string
डिफ़ॉल्ट:en

सूचना ईमेल के लिए भाषा। स्कीमा स्तर पर किसी भी स्ट्रिंग को स्वीकार करता है; असमर्थित कोड बिना किसी सूचना के अंग्रेज़ी (en) पर फ़ालबैक हो जाते हैं।

उदाहरण:

"en"

email_preview_token
string
write-only

निर्णय ईमेल का पूर्वावलोकन करें (Approved और Declined के लिए) या पुनः सबमिशन ईमेल का पूर्वावलोकन करें (Resubmitted के लिए) से वैकल्पिक रसीद: इसका preview_token। केवल send_email: true के साथ मान्य; इसके बिना अनुरोध 400 लौटाता है। प्राप्तकर्ता, भाषा, सत्र स्थिति, प्रेषक और ईमेल (और पुनः सबमिशन के लिए, चयनित चरण) अभी भी पूर्वावलोकन से मेल खाने चाहिए, और रसीद 15 मिनट के बाद समाप्त हो जाती है। अन्यथा सत्र बदलने या ईमेल भेजे जाने से पहले अनुरोध 409 लौटाता है। मौजूदा इंटीग्रेशन इस फ़ील्ड को छोड़ सकते हैं।

Required string length: 1 - 512

प्रतिक्रिया

स्टेटस अपडेट किया गया। रिस्पॉन्स में केवल session_id होता है; निर्णय प्राप्त करें के माध्यम से अपडेट किया गया सत्र प्राप्त करें। बदलाव कमिट होने पर status.updated webhook ट्रिगर होता है। Approved या Declined को दोहराने पर वही बॉडी वापस आती है और कुछ नहीं बदलता है।

session_id
string<uuid>

अपडेट किए गए सत्र का UUID।

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