मुख्य सामग्री पर जाएं
POST
Python

प्राधिकरण

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>
आवश्यक

व्यवसाय सत्यापन (KYB) सत्र का UUID। यह API कुंजी के एप्लिकेशन से संबंधित होना चाहिए।

उदाहरण:

"33333333-4444-5555-6666-777777777777"

क्वेरी पैरामीटर

node_id
string

KYB चरण का वर्कफ़्लो नोड। केवल तभी आवश्यक जब वर्कफ़्लो में एक से अधिक KYB नोड हों; डिफ़ॉल्ट रूप से Didit सत्र के अपने नोड का उपयोग करता है।

बॉडी

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

क्या पक्ष कोई व्यक्ति है या कंपनी।

उपलब्ध विकल्प:
person,
company
nationality
string
आवश्यक

किसी व्यक्ति की राष्ट्रीयता, या किसी कंपनी के निगमन का देश। प्रत्येक पक्ष के लिए आवश्यक।

Maximum string length: 100
full_name
string

किसी व्यक्ति का पूरा नाम। इसे भेजें, या first_name और last_name भेजें।

Maximum string length: 255
first_name
string
Maximum string length: 128
last_name
string
Maximum string length: 128
role
enum<string>

पक्ष द्वारा धारित भूमिका। roles के साथ विनिमेय; दोनों भेजे जाने पर वे मर्ज हो जाते हैं।

उपलब्ध विकल्प:
director,
non_executive_director,
secretary,
chairman,
ubo,
shareholder,
representative,
founder,
legal_advisor,
authorized_signatory,
trustee,
beneficiary,
settlor,
protector,
company_officer,
investor,
other
roles
enum<string>[]

पार्टी द्वारा धारण की गई प्रत्येक भूमिका। एक व्यक्ति को कम से कम एक भूमिका की आवश्यकता होती है (यहाँ या role में)।

उपलब्ध विकल्प:
director,
non_executive_director,
secretary,
chairman,
ubo,
shareholder,
representative,
founder,
legal_advisor,
authorized_signatory,
trustee,
beneficiary,
settlor,
protector,
company_officer,
investor,
other
position
string

किसी व्यक्ति का पदनाम।

Maximum string length: 128
date_of_birth
string<date> | null
company_name
string

कंपनी पक्षकार का नाम। जब entity_type company हो तो आवश्यक है।

Maximum string length: 255
registration_number
string

कंपनी पक्ष की पंजीकरण संख्या।

Maximum string length: 100
email
string<email>

सत्यापन लिंक कहाँ भेजा जाता है। तब आवश्यक होता है जब पक्ष को सत्यापन पूरा करना होता है, जो वर्कफ़्लो की भूमिका सेटिंग्स और स्वामित्व थ्रेशोल्ड पर निर्भर करता है।

ownership_percent
number | null

कंपनी का वह हिस्सा जिसका स्वामी वह पक्ष है।

phone_number
string
Maximum string length: 32
custom_fields
object

वर्कफ़्लो-परिभाषित अतिरिक्त फ़ील्ड।

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

इस पक्ष के सत्यापन को छोड़ने का अनुरोध करें। केवल तभी मान्य होता है जब वर्कफ़्लो की प्रमुख व्यक्ति सेटिंग्स में पक्ष की भूमिका छोड़ने की अनुमति देती है।

प्रतिक्रिया

ड्राफ़्ट बनाया गया।

draft_id
string<uuid>
आवश्यक
created_at
string<date-time>
आवश्यक
updated_at
string<date-time>
आवश्यक
party
object
आवश्यक
अंतिम संशोधन 7 नवंबर 2026