मुख्य सामग्री पर जाएं
GET
cURL

प्राधिकरण

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।

पथ पैरामीटर

settings_uuid
string<uuid>
आवश्यक

वर्कफ़्लो का प्रति-संस्करण UUID (सूची endpoint द्वारा लौटाया गया uuid मान)। वर्कफ़्लो के प्रत्येक संस्करण का अपना settings_uuid होता है।

प्रतिक्रिया

पूर्ण वर्कफ़्लो कॉन्फ़िगरेशन। इसका स्वरूप रॉ VerificationSettings सीरियलाइज़ेशन है (~190 फ़ील्ड: प्रत्येक सुविधा टॉगल, थ्रेशोल्ड, चेतावनी कार्रवाई, अनुमत-दस्तावेज़ कॉन्फ़िग, workflow_graph, पुनः प्रयास नीति, कॉलबैक और मूल्य निर्धारण)। नीचे दिया गया उदाहरण संक्षिप्त है। नोट: features एक " + " से जुड़ी हुई स्ट्रिंग है (उदा. "OCR + LIVENESS"), कीमतें JSON संख्याएँ हैं, और is_editable केवल draft संस्करणों के लिए true है।

नीचे दिए गए फ़ील्ड टाइप किए गए हैं; ऑब्जेक्ट अतिरिक्त विशेषताओं के रूप में वर्कफ़्लो कॉन्फ़िगरेशन के हर दूसरे कॉलम (सुविधा टॉगल, थ्रेशोल्ड, चेतावनी कार्रवाइयाँ, अनुमत दस्तावेज़, कॉलबैक) को भी ले जाता है। वे फ़ील्ड जो workflow_type पर लागू नहीं होते हैं, वे null हैं।

uuid
string<uuid>

प्रति-संस्करण पहचानकर्ता (settings_uuid)। वर्कफ़्लो के प्रत्येक संस्करण का अपना पहचानकर्ता होता है।

workflow_id
string<uuid>

वर्कफ़्लो के प्रत्येक संस्करण द्वारा साझा किया गया स्थिर पहचानकर्ता। इसके साथ बनाए गए सत्र नवीनतम प्रकाशित संस्करण का उपयोग करते हैं।

workflow_label
string

वर्कफ़्लो का डिस्प्ले नाम।

workflow_type
enum<string> | null

वर्कफ़्लो टेम्पलेट। बिना टेम्पलेट के बनाए गए ग्राफ़ वर्कफ़्लो के लिए null।

उपलब्ध विकल्प:
kyc,
kyb,
adaptive_age_verification,
biometric_authentication,
address_verification,
questionnaire_verification,
email_verification,
phone_verification,
null
is_default
boolean

क्या यह एप्लिकेशन का डिफ़ॉल्ट वर्कफ़्लो है।

is_archived
boolean

संग्रहीत वर्कफ़्लो नए सत्र शुरू नहीं कर सकते।

version
integer

वर्कफ़्लो के भीतर संस्करण संख्या।

status
enum<string>

ड्राफ़्ट वर्ज़न संपादन योग्य होते हैं; प्रकाशित वर्ज़न अपरिवर्तनीय होते हैं और नए सत्रों के लिए उपयोग किए जाते हैं।

उपलब्ध विकल्प:
draft,
published
published_at
string<date-time> | null

यह संस्करण कब प्रकाशित हुआ था। ड्राफ़्ट के लिए null।

is_simple_workflow
boolean

true जब वर्कफ़्लो में कोई कस्टम workflow_graph न हो।

is_editable
boolean

केवल draft संस्करणों के लिए true।

workflow_url
string<uri>

सार्वजनिक URL जो इस वर्कफ़्लो के साथ एक सत्र शुरू करता है।

workflow_graph
object | null

वर्कफ़्लो की ग्राफ़ संरचना (नोड्स और एजेस)। सरल वर्कफ़्लो के लिए null।

features
string

सक्षम सुविधाएँ " + " से जुड़ी हुई हैं, उदाहरण के लिए "OCR + LIVENESS"।

total_price
number | null

प्रति सत्र कीमत; ग्राफ़ वर्कफ़्लो के लिए सबसे महंगा पथ।

min_price
number | null

वर्कफ़्लो के माध्यम से सबसे सस्ते पथ की कीमत।

max_price
number | null

वर्कफ़्लो के माध्यम से सबसे महंगे पथ की कीमत।

special_add_on_prices
object | null

संगठन-विशिष्ट ऐड-ऑन कीमतें, या कोई सेट न होने पर null।

max_retry_attempts
integer

अस्वीकृत सत्यापन के बाद अनुमत पुनः प्रयास।

retry_window_days
integer | null

वे दिन जिनके दौरान पुनः प्रयास करने की अनुमति है।

session_expiration_time
integer

किसी अधूरे सत्र की समय-सीमा समाप्त होने से पहले के सेकंड।

questionnaire
object | null

वर्कफ़्लो से जुड़ी प्रश्नावली, या null।

kyb_role_settings
object[]

KYB प्रमुख व्यक्तियों के लिए प्रति-भूमिका सत्यापन सेटिंग्स।

created_at
string<date-time>
updated_at
string<date-time>
signature_availability
object

कौन से ई-हस्ताक्षर स्तर अभी हस्ताक्षर कर सकते हैं। signature_level सेट करने से पहले इसे जांचें। kyc, kyb और ग्राफ़ वर्कफ़्लो पर लौटाया जाता है।

is_bank_verification_enabled
boolean

क्या एक सरल KYC या KYB वर्कफ़्लो बैंक सत्यापन चलाता है। यह संपर्क चरणों (और स्थान सत्यापन) के बाद और डेटाबेस सत्यापन, AML और IP विश्लेषण से पहले चलता है। बैंक सत्यापन अभी सामान्य रूप से उपलब्ध नहीं है: जहां भी यह सक्षम नहीं है, इसे चालू करना अस्वीकृत कर दिया जाता है।

bank_verification_config
object

एक सरल वर्कफ़्लो की बैंक सत्यापन सेटिंग्स, उन्हीं कुंजियों के साथ जो एक BANK_VERIFICATION नोड लेता है (उदाहरण के लिए bank_countries और bank_method_order)। अज्ञात कुंजियाँ छोड़ दी जाती हैं। प्रत्येक कुंजी वैकल्पिक है और एक अनुपस्थित कुंजी अपने डिफ़ॉल्ट को बनाए रखती है, इसलिए {} का अर्थ सभी डिफ़ॉल्ट हैं। देखें बैंक सत्यापन सेटिंग्स।

उदाहरण:
is_geolocation_enabled
boolean

क्या एक सरल KYC वर्कफ़्लो स्थान सत्यापन चलाता है। यह संपर्क चरणों के बाद और बैंक सत्यापन तथा डेटाबेस सत्यापन से पहले चलता है। व्यवसाय (KYB) वर्कफ़्लो इसे नहीं चला सकते।

geolocation_config
object

एक साधारण वर्कफ़्लो की स्थान सत्यापन सेटिंग्स, जिनमें वही कुंजियाँ होती हैं जो एक GEOLOCATION नोड लेता है (उदाहरण के लिए is_geolocation_geofencing_enabled और geolocation_max_attempts)। अज्ञात कुंजियों को छोड़ दिया जाता है। प्रत्येक कुंजी वैकल्पिक है और अनुपस्थित कुंजी अपना डिफ़ॉल्ट मान बनाए रखती है, इसलिए {} का अर्थ सभी डिफ़ॉल्ट मान हैं।

उदाहरण:
अंतिम संशोधन 7 नवंबर 2026