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

बॉडी

application/json

एक CUSTOM नियम बनाता है। ACTIVE मोड में नियम नए लेन-देन के लिए तुरंत प्रभावी होते हैं - TEST मोड में बनाएं और पहले बैकटेस्ट करें।

title
string
आवश्यक

नियम का नाम। गैर-हटाए गए नियमों में प्रति एप्लिकेशन अद्वितीय; डुप्लिकेट 400 लौटाते हैं।

category
string
आवश्यक

समूहीकरण और रिपोर्टिंग के लिए उपयोग की जाने वाली जोखिम थीम, उदाहरण के लिए finance, aml_ctf, anomaly_detection, fatf, device_intelligence, crypto_monitoring, travel_rule, responsible_gaming, e_commerce।

mode
enum<string>
आवश्यक

ACTIVE लाइव मूल्यांकन करता है। TEST नियम चलाने का मूल्यांकन और रिकॉर्ड करता है लेकिन कभी भी स्कोर या स्थिति को प्रभावित नहीं करता है - यह अनुशंसित शुरुआती मोड है। DISABLED को छोड़ दिया जाता है।

उपलब्ध विकल्प:
ACTIVE,
DISABLED,
TEST
description
string | null
evaluation_mode
enum<string>
डिफ़ॉल्ट:ALL

क्या प्रत्येक शर्त का मिलान होना चाहिए (ALL) या कम से कम एक का (ANY)। जब शर्तें group_index का उपयोग करती हैं तो अनदेखा किया जाता है।

उपलब्ध विकल्प:
ALL,
ANY
scope
object

नियम किन लेन-देन पर लागू होता है। केवल ये तीन कुंजियाँ स्वीकार की जाती हैं।

conditions
object[]
aggregation
object[]
actions
object[]

एक नियम कार्रवाई। एक नियम में कई कार्रवाइयाँ हो सकती हैं; मेल खाने पर सभी एक साथ लागू की जाती हैं। TEST मोड में नियम बिना कोई कार्रवाई लागू किए यह रिकॉर्ड करते हैं कि वे क्या करते।

metadata
object

नियम पर संग्रहीत फ़्री-फ़ॉर्म मेटाडेटा।

प्रतिक्रिया

बनाया गया नियम।

uuid
string<uuid>
title
string

नियम का नाम। गैर-हटाए गए नियमों में प्रति एप्लिकेशन अद्वितीय; डुप्लिकेट 400 लौटाते हैं।

description
string | null
category
string

समूहीकरण और रिपोर्टिंग के लिए उपयोग की जाने वाली जोखिम थीम, उदाहरण के लिए finance, aml_ctf, anomaly_detection, fatf, device_intelligence, crypto_monitoring, travel_rule, responsible_gaming, e_commerce।

mode
enum<string>

ACTIVE लाइव मूल्यांकन करता है। TEST नियम चलाने का मूल्यांकन और रिकॉर्ड करता है लेकिन कभी भी स्कोर या स्थिति को प्रभावित नहीं करता है - यह अनुशंसित शुरुआती मोड है। DISABLED को छोड़ दिया जाता है।

उपलब्ध विकल्प:
ACTIVE,
DISABLED,
TEST
evaluation_mode
enum<string>
डिफ़ॉल्ट:ALL

क्या प्रत्येक शर्त का मिलान होना चाहिए (ALL) या कम से कम एक का (ANY)। जब शर्तें group_index का उपयोग करती हैं तो अनदेखा किया जाता है।

उपलब्ध विकल्प:
ALL,
ANY
scope
object

नियम किन लेन-देन पर लागू होता है। केवल ये तीन कुंजियाँ स्वीकार की जाती हैं।

conditions
object[]
aggregation
object[]
actions
object[]

एक नियम कार्रवाई। एक नियम में कई कार्रवाइयाँ हो सकती हैं; मेल खाने पर सभी एक साथ लागू की जाती हैं। TEST मोड में नियम बिना कोई कार्रवाई लागू किए यह रिकॉर्ड करते हैं कि वे क्या करते।

metadata
object

नियम पर संग्रहीत फ़्री-फ़ॉर्म मेटाडेटा।

severity
enum<string> | null

लाइब्रेरी नियमों से मिलने वाली सूचनात्मक गंभीरता; कस्टम नियमों पर सेट करने योग्य नहीं है।

उपलब्ध विकल्प:
UNKNOWN,
LOW,
MEDIUM,
HIGH,
CRITICAL
source
enum<string>

PRESET नियम लाइब्रेरी से आते हैं (इंस्टॉल/अनइंस्टॉल, केवल-मोड संपादन); CUSTOM नियम पूरी तरह से आपके हैं।

उपलब्ध विकल्प:
PRESET,
CUSTOM
library_key
string | null

स्थिर लाइब्रेरी पहचानकर्ता; कस्टम नियमों के लिए null।

latest_triggered_at
string<date-time> | null
run_count
integer

इस नियम से कितने लेन-देन मेल खाते हैं।

approved_count
integer
reviewed_count
integer
declined_count
integer
awaiting_user_count
integer
approved_pct
number
reviewed_pct
number
declined_pct
number
created_at
string<date-time>
updated_at
string<date-time>
अंतिम संशोधन 7 नवंबर 2026