मुख्य सामग्री पर जाएं
POST
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।

हेडर

Idempotency-Key
string

वैकल्पिक पुनः प्रयास-सुरक्षा कुंजी, 255 वर्णों तक। उसी अनुरोध बॉडी के साथ उसी कुंजी का पुन: उपयोग करने पर दूसरी स्क्रीनिंग चलाए या उसका बिल लिए बिना मूल रिस्पॉन्स वापस मिलता है। भिन्न बॉडी के साथ कुंजी का पुन: उपयोग करने पर 409 मिलता है।

Maximum string length: 255

बॉडी

application/json
full_name
string
आवश्यक

स्क्रीन किए जाने वाले व्यक्ति या कंपनी का पूरा नाम। न्यूनतम 2 वर्ण - स्क्रीनिंग प्रदाता की अपनी न्यूनतम सीमा। कोई भी स्क्रीनिंग चलने से पहले इस फ़ील्ड पर एक छोटा या खाली नाम 400 लौटाता है, इसलिए कुछ भी बिल नहीं किया जाता है।

Minimum string length: 2
उदाहरण:

"Antonio Ejemplo Modelo"

entity_type
enum<string>
डिफ़ॉल्ट:person

स्क्रीन करने के लिए निकाय का प्रकार। डिफ़ॉल्ट रूप से person।

उपलब्ध विकल्प:
person,
company
date_of_birth
string<date>

जन्म तिथि (व्यक्तियों के लिए) या निगमन तिथि (कंपनियों के लिए), YYYY-MM-DD। DOB वेट के माध्यम से मिलान की सटीकता में सुधार करता है।

उदाहरण:

"1972-02-29"

nationality
string

ISO 3166-1 alpha-2 देश कोड (उदाहरण के लिए ES)। अमान्य कोड 400 लौटाते हैं। देश के वेटेज के माध्यम से मिलान परिशुद्धता में सुधार करता है।

उदाहरण:

"ES"

document_number
string

पहचान दस्तावेज़ संख्या। भारित नहीं — यह गोल्डन की के रूप में कार्य करता है: एक सटीक मिलान हिट के match_score को 100 में बदल देता है, जबकि एक पूर्ण बेमेल इसे दंडित करता है। स्क्रीनिंग प्रदाता को खोज फ़िल्टर के रूप में केवल तभी भेजा जाता है जब यह 2-50 वर्ण का हो; उस सीमा से बाहर के मान को स्वीकार और संग्रहीत किया जाता है, और स्क्रीनिंग अभी भी चलती है और उसका बिल लिया जाता है, बस इसे दस्तावेज़ संख्या द्वारा सीमित नहीं किया जाता है।

aml_score_approve_threshold
number
डिफ़ॉल्ट:80

जोखिम स्कोर थ्रेशोल्ड जिस पर या जिसके नीचे परिणाम Approved होता है। aml_score_review_threshold से ≤ होना चाहिए (अन्यथा 400)।

आवश्यक सीमा: 0 <= x <= 100
aml_score_review_threshold
number
डिफ़ॉल्ट:100

जोखिम स्कोर थ्रेशोल्ड जिसके ऊपर परिणाम Declined होता है। दो थ्रेशोल्ड के बीच के स्कोर In Review उत्पन्न करते हैं।

आवश्यक सीमा: 0 <= x <= 100
aml_name_weight
integer
डिफ़ॉल्ट:60

प्रति-हिट मिलान स्कोर में नाम समानता का भार। तीनों भारों का योग ठीक 100 होना चाहिए (अन्यथा 400)।

आवश्यक सीमा: 0 <= x <= 100
aml_dob_weight
integer
डिफ़ॉल्ट:25

प्रति-हिट मिलान स्कोर में जन्म तिथि का भार।

आवश्यक सीमा: 0 <= x <= 100
aml_country_weight
integer
डिफ़ॉल्ट:15

प्रति-हिट मिलान स्कोर में देश/राष्ट्रीयता का भार।

आवश्यक सीमा: 0 <= x <= 100
aml_match_score_threshold
integer
डिफ़ॉल्ट:93

प्रति-हिट कटऑफ़: इससे कम match_score वाले हिट False Positive हैं (जोखिम मूल्यांकन से बाहर रखे गए); इसके बराबर या अधिक स्कोर वाले Unreviewed संभावित मिलान हैं।

आवश्यक सीमा: 0 <= x <= 100
include_adverse_media
boolean
डिफ़ॉल्ट:false

नकारात्मक कवरेज के लिए समाचार मीडिया में भी खोजें। परिणाम एकत्र होने के दौरान ~30 सेकंड तक की लेटेंसी जुड़ती है — ≥60 सेकंड के क्लाइंट टाइमआउट का उपयोग करें।

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

इस प्रोफ़ाइल की पुनः स्क्रीनिंग जारी रखें और webhook के माध्यम से परिवर्तनों को पुश करें। save_api_request=true आवश्यक है (अन्यथा 400)।

save_api_request
boolean
डिफ़ॉल्ट:true

स्क्रीनिंग को एक सत्र के रूप में बनाए रखें (कंसोल दृश्यता, निर्णय endpoint, webhooks, हिट समीक्षा)। स्टेटलेस जाँच के लिए false पर सेट करें।

vendor_data
string

स्क्रीन किए गए उपयोगकर्ता के लिए आपका पहचानकर्ता; वापस दोहराया जाता है और सत्र के साथ संग्रहीत किया जाता है।

metadata
object | null

अनुरोध के साथ संग्रहीत और वापस लौटाया गया फ़्री-फ़ॉर्म JSON।

sandbox_scenario
string

केवल-सैंडबॉक्स परिदृश्य स्लग। केवल तब स्वीकार किया जाता है जब API कुंजी सैंडबॉक्स-मोड एप्लिकेशन से संबंधित हो; लाइव एप्लिकेशन्स पर अस्वीकृत। एक स्टैंडअलोन स्क्रीनिंग में आर्म करने के लिए कोई सत्र नहीं होता है, इसलिए स्लग स्वयं स्क्रीनिंग अनुरोध पर जाता है: decline_aml_hit एक प्रोडक्शन-आकार का हिट लौटाता है और स्क्रीनिंग को Declined के रूप में तय करता है, review_aml_possible_match इसे In Review के रूप में तय करता है, और ऐसा परिदृश्य जो किसी भी AML परिणाम को आर्म नहीं करता है, वह स्क्रीनिंग को क्लीन छोड़ देता है। परिदृश्य कैटलॉग को GET /v1/sandbox/scenarios/ पर या Sandbox & Test Data में देखें।

उदाहरण:

"decline_aml_hit"

प्रतिक्रिया

स्क्रीनिंग पूरी हुई। aml.status आपके थ्रेशोल्ड को दर्शाता है; आंतरिक समावेशन सीमा पर या उससे ऊपर का प्रत्येक हिट aml.hits में अपने पहचान संबंधी match_score, निकाय के risk_score, और मिलान की व्याख्या करने वाले score_breakdown के साथ सूचीबद्ध होता है।

request_id
string<uuid>

save_api_request=true होने पर सहेजी गई सत्र ID (GET /v3/session/{sessionId}/decision/ के साथ उपयोग योग्य); अन्यथा एक क्षणिक सहसंबंध UUID।

aml
object
vendor_data
string | null

आपके द्वारा भेजे गए vendor_data का इको।

metadata
object | null

आपके द्वारा भेजे गए metadata का इको।

created_at
string<date-time>
अंतिम संशोधन 7 नवंबर 2026