मुख्य सामग्री पर जाएं
PATCH
curl
फ़ील्ड कुंजियाँ वही हैं जो आपने वर्कफ़्लो में दस्तावेज़ के लिए कॉन्फ़िगर की हैं। दस्तावेज़ और फ़ील्ड कैसे सेट किए जाते हैं, यह जानने के लिए Document AI देखें, और सत्र निर्णय में परिणाम कहाँ दिखता है, यह जानने के लिए Document AI रिपोर्ट देखें।

प्राधिकरण

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 (POST /v3/session/ द्वारा लौटाया गया session_id)। उपयोगकर्ता सत्यापन (KYC) और व्यवसाय सत्यापन (KYB) दोनों सत्र ID स्वीकार करता है: सर्वर दोनों सत्र प्रकारों में ID को रिज़ॉल्व करता है। यह एक सही प्रारूप वाला UUID होना चाहिए; गलत प्रारूप वाला मान रूट से मेल नहीं खाता है और एक HTML 404 लौटाता है।

उदाहरण:

"11111111-2222-3333-4444-555555555555"

documentUuid
string<uuid>
आवश्यक

Document AI दस्तावेज़ का UUID (GET /v3/session/{sessionId}/decision/ में document_ai_documents[].items[].uuid)। यह पाथ के सत्र से संबंधित होना चाहिए।

उदाहरण:

"44444444-5555-6666-7777-888888888888"

बॉडी

application/json
extracted_data
object

फ़ील्ड कुंजियाँ (दस्तावेज़ के लिए आपके द्वारा कॉन्फ़िगर की गई कुंजियाँ) और उनके सही किए गए मान। एक JSON ऑब्जेक्ट होना चाहिए; संग्रहीत डेटा में कुंजी दर कुंजी मर्ज किया जाता है। null भेजने के बजाय इसे छोड़ दें, जिससे 400 वापस आता है।

उदाहरण:
status
enum<string>

दस्तावेज़ की नई समीक्षा स्थिति।

उपलब्ध विकल्प:
Approved,
Declined,
In Review,
Not Finished
उदाहरण:

"Approved"

प्रतिक्रिया

दस्तावेज़ अपडेट किया गया। मर्ज के बाद दस्तावेज़ लौटाता है।

uuid
string<uuid>
आवश्यक

दस्तावेज़ पहचानकर्ता।

document_key
string
आवश्यक

कॉन्फ़िगर किया गया दस्तावेज़ जिससे यह अपलोड संबंधित है।

original_filename
string | null
आवश्यक

फ़ाइल नाम जिसके साथ दस्तावेज़ अपलोड किया गया था।

file_url
string | null
आवश्यक

अपलोड की गई फ़ाइल का स्टोरेज पाथ। यह कोई डाउनलोड लिंक नहीं है: फ़ाइल डाउनलोड करने के लिए सत्र निर्णय से प्री-साइन्ड file_url पढ़ें।

status
enum<string>
आवश्यक

दस्तावेज़ की समीक्षा स्थिति।

उपलब्ध विकल्प:
Not Finished,
Approved,
Declined,
In Review,
Resub Requested
extracted_data
object | null
आवश्यक

मर्ज के बाद सभी निकाले गए फ़ील्ड, जिन्हें फ़ील्ड कुंजी द्वारा व्यवस्थित किया गया है।

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