> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # إنشاء قاعدة مراقبة المعاملات عبر API - قواعد KYT > أنشئ قاعدة KYT مخصصة عبر API من Didit مع الشروط ونوافذ السرعة والنطاق والإجراءات. أنشئها في وضع الاختبار ثم جرّبها رجعياً وفعّلها. موجّه API لإنشاء قاعدة نسخ الموجّه إلى الحافظة \

\`Create a custom transaction-monitoring rule on my Didit application.

Endpoint:
POST https://verification.didit.me/v3/transactions/rules/

Authentication:
Use the x-api-key header with my Didit API key.

Request body (application/json):
\{
"title": "Structuring - inbound (custom)",   // required, unique per application - duplicate -> 400
"description": "20+ inbound EUR transfers, all under 10,000 EUR, 30 days",
"category": "finance",                        // required: finance, aml_ctf, anomaly_detection, fatf, device_intelligence, crypto_monitoring, travel_rule, responsible_gaming, e_commerce, ...
"mode": "TEST",                               // required: TEST (recommended start - evaluates, never affects transactions), ACTIVE, DISABLED
"evaluation_mode": "ALL",                     // ALL = every condition must match, ANY = at least one
"scope": {"transaction_types": ["finance"], "directions": ["INBOUND"]},  // constrains the transaction being evaluated; optional keys: transaction_types, directions (INBOUND/OUTBOUND), action_types
"conditions": [                               // read the transaction being evaluated, never the history window
\{"field": "currency", "operator": "eq", "value": "EUR"},
\{"field": "amount", "operator": "lt", "value": 10000}
],
"aggregation": [                              // velocity over the history window: ALL entries must match
\{"metric": "count", "operator": "gte", "value": 20, "window": "30d",
 "filters": {"direction": "INBOUND", "transaction_type": "finance", "currency": "EUR", "subject_vendor_data": "__current__"}},
\{"metric": "max", "field": "amount", "operator": "lt", "value": 10000, "window": "30d",
 "filters": {"direction": "INBOUND", "transaction_type": "finance", "currency": "EUR", "subject_vendor_data": "__current__"}}
],
"actions": [{"type": "add_score", "value": 35}]
}

Schema essentials:
\- Condition operators: eq, ne, gt, gte, lt, lte, in, not_in, contains, not_contains, contains_any (list of strings), regex, fuzzy_match (needs "score" 0-100), exists/is_not_empty/is_not_null, not_exists/is_empty/is_null.
\- Condition fields include amount, preferred_currency_amount, direction, action_type, payment_details, subject_vendor_data, counterparty_country, subject_device_fingerprint, subject_payment_method_*, travel_rule_status, tags, and custom_values. for your own custom_properties.
\- value_type turns "value" into a List UUID ("list"), another field path ("field"), or a relative date ("relative_date").
\- Aggregation windows: m (MINUTES), h, d. A filter value of "__current__" means same-as-the-evaluated-transaction. Records without the grouped value are never grouped together: when the evaluated transaction has no value for a "__current__" field (no counterparty, no device fingerprint), that aggregation does not match, whatever its operator.
\- Conditions and aggregation filters are NOT interchangeable. A condition constrains only the transaction being evaluated; an aggregation filter constrains only the historical window, and it compares by equality or list membership - there is no lt/gte filter. Express a range over the window as a max/min aggregation (e.g. max amount lt 10000 with currency pinned to EUR keeps every transaction in that window under 10,000 EUR), and repeat direction/currency/transaction_type on BOTH halves when the rule promises them - otherwise the rule fires on transactions it never meant to cover.
\- Actions: add_score {value}, change_status {value, workflow_id (REQUIRED for AWAITING_USER)}, add_tags {tag_uuid|tag_name, tag_color}, add_note {note}, add_to_list {list_id}, open_case {blueprint, grouping, attach_matched_transaction}.

Recommended workflow:
1\. Create in mode TEST.
2\. POST /v3/transactions/rules/backtest/ with the SAME conditions, aggregation, evaluation_mode and scope to see matches over your history. Omitted conditions, aggregation and scope add no constraints of their own; dropping scope can include directions or transaction types the saved rule skips. Omitted evaluation_mode defaults to ALL (which can reduce matches for an ANY rule), and omitted period_days defaults to 90 days, not unlimited history.
3\. PATCH the rule to mode ACTIVE once the numbers look right.

Sandbox fixtures for this example: at least 20 inbound EUR finance transactions for the same subject within 30 days, each with raw amount below 10000. No normalized amount is required. Sandbox ingestion does not evaluate rules; call backtest explicitly.

Failure modes:
\- 400 - duplicate title, unknown operator/metric, malformed window, invalid scope direction, contains_any without a list, fuzzy_match without a score, or AWAITING_USER without workflow_id. The body names the exact index and problem.
\- 401 - missing or malformed x-api-key.

Full guide: /transaction-monitoring/rules-api.`

\
الصق في ## OpenAPI ````yaml ar/openapi-25.json POST /v3/transactions/rules/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API التحقق من الهوية. قم بالمصادقة باستخدام الرأس x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/transactions/rules/: post: tags: - Transactions summary: إنشاء قاعدة description: >- إنشاء قاعدة CUSTOM لمراقبة المعاملات. العناوين فريدة لكل تطبيق (التكرار -> 400). يجب أن يحمل أي إجراء `change_status` يستهدف `AWAITING_USER` المعامل `workflow_id`. تنطبق القواعد التي تم إنشاؤها في وضع ACTIVE على المعاملات الجديدة على الفور - سير العمل الموصى به هو الإنشاء في وضع TEST، وإجراء اختبار رجعي، ثم تبديل الوضع إلى ACTIVE. لتعديل قاعدة من المكتبة، أنشئها كنسخة: أرسل تعريف قاعدة المكتبة مع `metadata.based_on` (مفتاح المكتبة الخاص بها) و`metadata.based_on_rule_uuid`. operationId: createTransactionRule requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TransactionRuleCreateRequest' example: title: Structuring - inbound (custom) description: 20+ inbound EUR transfers, all under 10,000 EUR, 30 days category: finance mode: TEST evaluation_mode: ALL scope: transaction_types: - finance directions: - INBOUND conditions: - field: currency operator: eq value: EUR - field: amount operator: lt value: 10000 aggregation: - metric: count operator: gte value: 20 window: 30d filters: direction: INBOUND transaction_type: finance subject_vendor_data: __current__ currency: EUR - metric: max field: amount operator: lt value: 10000 window: 30d filters: direction: INBOUND transaction_type: finance subject_vendor_data: __current__ currency: EUR actions: - type: add_score value: 35 responses: '201': description: القاعدة التي تم إنشاؤها. content: application/json: schema: $ref: '#/components/schemas/TransactionRuleDetail' '400': description: >- خطأ في التحقق من الصحة - عنوان مكرر، أو عامل تشغيل/مقياس غير معروف، أو نافذة زمنية غير صحيحة التنسيق، أو اتجاه نطاق غير صالح، أو AWAITING_USER بدون workflow_id. content: application/json: schema: type: object example: title: - A rule with this name already exists. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X POST 'https://verification.didit.me/v3/transactions/rules/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"title": "Structuring - inbound (custom)", "description": "20+ inbound EUR transfers, all under 10,000 EUR, 30 days", "category": "finance", "mode": "TEST", "evaluation_mode": "ALL", "scope": {"transaction_types": ["finance"], "directions": ["INBOUND"]}, "conditions": [{"field": "currency", "operator": "eq", "value": "EUR"}, {"field": "amount", "operator": "lt", "value": 10000}], "aggregation": [{"metric": "count", "operator": "gte", "value": 20, "window": "30d", "filters": {"direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR"}}, {"metric": "max", "field": "amount", "operator": "lt", "value": 10000, "window": "30d", "filters": {"direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR"}}], "actions": [{"type": "add_score", "value": 35}]}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.transactions.rules.create( title="Structuring - inbound (custom)", description="20+ inbound EUR transfers, all under 10,000 EUR, 30 days", category="finance", mode="TEST", evaluation_mode="ALL", scope={ "transaction_types": ["finance"], "directions": ["INBOUND"], }, conditions=[{ "field": "currency", "operator": "eq", "value": "EUR", }, { "field": "amount", "operator": "lt", "value": 10000, }], aggregation=[{ "metric": "count", "operator": "gte", "value": 20.0, "window": "30d", "filters": {"direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR"}, }, { "metric": "max", "field": "amount", "operator": "lt", "value": 10000.0, "window": "30d", "filters": {"direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR"}, }], actions=[{ "type": "add_score", "value": 35, }], ) print(result) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.transactions.rules.create({ title: "Structuring - inbound (custom)", description: "20+ inbound EUR transfers, all under 10,000 EUR, 30 days", category: "finance", mode: "TEST", evaluation_mode: "ALL", scope: { transaction_types: ["finance"], directions: ["INBOUND"], }, conditions: [{ field: "currency", operator: "eq", value: "EUR", }, { field: "amount", operator: "lt", value: 10000, }], aggregation: [{ metric: "count", operator: "gte", value: 20.0, window: "30d", filters: { direction: "INBOUND", transaction_type: "finance", subject_vendor_data: "__current__", currency: "EUR" }, }, { metric: "max", field: "amount", operator: "lt", value: 10000.0, window: "30d", filters: { direction: "INBOUND", transaction_type: "finance", subject_vendor_data: "__current__", currency: "EUR" }, }], actions: [{ type: "add_score", value: 35, }], }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.Create(ctx, didit.TransactionRuleCreateRequest{\n\tTitle: \"Structuring - inbound (custom)\",\n\tDescription: didit.String(\"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\"),\n\tCategory: \"finance\",\n\tMode: \"TEST\",\n\tEvaluationMode: didit.Some(didit.TransactionRuleCreateRequestEvaluationMode(\"ALL\")),\n\tScope: didit.Some(didit.TransactionRuleScopeParam{\n\t\tTransactionTypes: didit.Some([]string{\"finance\"}),\n\t\tDirections: didit.Some([]didit.TransactionRuleScopeDirections{\"INBOUND\"}),\n\t}),\n\tConditions: didit.Some([]didit.TransactionRuleConditionParam{{\n\t\tField: \"currency\",\n\t\tOperator: \"eq\",\n\t\tValue: didit.Some[any](\"EUR\"),\n\t}, {\n\t\tField: \"amount\",\n\t\tOperator: \"lt\",\n\t\tValue: didit.Some[any](10000),\n\t}}),\n\tAggregation: didit.Some([]didit.TransactionRuleAggregationParam{{\n\t\tMetric: didit.Some(didit.TransactionRuleAggregationMetric(\"count\")),\n\t\tOperator: didit.Some(didit.TransactionRuleAggregationOperator(\"gte\")),\n\t\tValue: 20.0,\n\t\tWindow: didit.String(\"30d\"),\n\t\tFilters: didit.Some(map[string]any{\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}),\n\t}, {\n\t\tMetric: didit.Some(didit.TransactionRuleAggregationMetric(\"max\")),\n\t\tField: didit.String(\"amount\"),\n\t\tOperator: didit.Some(didit.TransactionRuleAggregationOperator(\"lt\")),\n\t\tValue: 10000.0,\n\t\tWindow: didit.String(\"30d\"),\n\t\tFilters: didit.Some(map[string]any{\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}),\n\t}}),\n\tActions: didit.Some([]didit.TransactionRuleActionParam{{\n\t\tType: \"add_score\",\n\t\tValue: didit.Some[any](35),\n\t}}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import java.util.List; import java.util.Map; import me.didit.Didit; import me.didit.types.TransactionRuleAction; import me.didit.types.TransactionRuleActionAddScore; import me.didit.types.TransactionRuleAggregation; import me.didit.types.TransactionRuleCondition; import me.didit.types.TransactionRuleCreateRequest; import me.didit.types.TransactionRuleScope; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.transactions().rules().create(TransactionRuleCreateRequest.builder() .title("Structuring - inbound (custom)") .description("20+ inbound EUR transfers, all under 10,000 EUR, 30 days") .category("finance") .mode(TransactionRuleCreateRequest.Mode.of("TEST")) .evaluationMode(TransactionRuleCreateRequest.EvaluationMode.of("ALL")) .scope(TransactionRuleScope.builder() .transactionTypes(List.of("finance")) .directions(List.of(TransactionRuleScope.Directions.of("INBOUND"))) .build()) .conditions(List.of( TransactionRuleCondition.builder() .field("currency") .operator(TransactionRuleCondition.Operator.of("eq")) .value("EUR") .build(), TransactionRuleCondition.builder() .field("amount") .operator(TransactionRuleCondition.Operator.of("lt")) .value(10000) .build())) .aggregation(List.of( TransactionRuleAggregation.builder() .metric(TransactionRuleAggregation.Metric.of("count")) .operator(TransactionRuleAggregation.Operator.of("gte")) .value(20.0) .window("30d") .filters(Map.of("direction", "INBOUND", "transaction_type", "finance", "subject_vendor_data", "__current__", "currency", "EUR")) .build(), TransactionRuleAggregation.builder() .metric(TransactionRuleAggregation.Metric.of("max")) .field("amount") .operator(TransactionRuleAggregation.Operator.of("lt")) .value(10000.0) .window("30d") .filters(Map.of("direction", "INBOUND", "transaction_type", "finance", "subject_vendor_data", "__current__", "currency", "EUR")) .build())) .actions(List.of(TransactionRuleAction.ofAddScore(TransactionRuleActionAddScore.builder() .type(TransactionRuleActionAddScore.Type.of("add_score")) .value(35L) .build()))) .build()); System.out.println(result); - lang: php label: PHP source: |- transactions->rules->create([ 'title' => 'Structuring - inbound (custom)', 'description' => '20+ inbound EUR transfers, all under 10,000 EUR, 30 days', 'category' => 'finance', 'mode' => 'TEST', 'evaluation_mode' => 'ALL', 'scope' => [ 'transaction_types' => ['finance'], 'directions' => ['INBOUND'], ], 'conditions' => [[ 'field' => 'currency', 'operator' => 'eq', 'value' => 'EUR', ], [ 'field' => 'amount', 'operator' => 'lt', 'value' => 10000, ]], 'aggregation' => [[ 'metric' => 'count', 'operator' => 'gte', 'value' => 20.0, 'window' => '30d', 'filters' => ['direction' => 'INBOUND', 'transaction_type' => 'finance', 'subject_vendor_data' => '__current__', 'currency' => 'EUR'], ], [ 'metric' => 'max', 'field' => 'amount', 'operator' => 'lt', 'value' => 10000.0, 'window' => '30d', 'filters' => ['direction' => 'INBOUND', 'transaction_type' => 'finance', 'subject_vendor_data' => '__current__', 'currency' => 'EUR'], ]], 'actions' => [[ 'type' => 'add_score', 'value' => 35, ]], ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.transactions.rules.create( title: "Structuring - inbound (custom)", description: "20+ inbound EUR transfers, all under 10,000 EUR, 30 days", category: "finance", mode: "TEST", evaluation_mode: "ALL", scope: { transaction_types: ["finance"], directions: ["INBOUND"], }, conditions: [{ field: "currency", operator: "eq", value: "EUR", }, { field: "amount", operator: "lt", value: 10000, }], aggregation: [{ metric: "count", operator: "gte", value: 20.0, window: "30d", filters: { direction: "INBOUND", transaction_type: "finance", subject_vendor_data: "__current__", currency: "EUR" }, }, { metric: "max", field: "amount", operator: "lt", value: 10000.0, window: "30d", filters: { direction: "INBOUND", transaction_type: "finance", subject_vendor_data: "__current__", currency: "EUR" }, }], actions: [{ type: "add_score", value: 35, }] ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Collections.Generic; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Transactions.Rules.CreateAsync(new TransactionRuleCreateRequest { Title = "Structuring - inbound (custom)", Description = "20+ inbound EUR transfers, all under 10,000 EUR, 30 days", Category = "finance", Mode = "TEST", EvaluationMode = new TransactionRuleCreateRequestEvaluationMode("ALL"), Scope = new TransactionRuleScope { TransactionTypes = new string[] { "finance" }, Directions = new TransactionRuleScopeDirections[] { "INBOUND" }, }, Conditions = new TransactionRuleCondition[] { new() { Field = "currency", Operator = "eq", Value = "EUR", }, new() { Field = "amount", Operator = "lt", Value = 10000, }, }, Aggregation = new TransactionRuleAggregation[] { new() { Metric = new TransactionRuleAggregationMetric("count"), Operator = new TransactionRuleAggregationOperator("gte"), Value = 20.0, Window = "30d", Filters = new Dictionary { ["direction"] = "INBOUND", ["transaction_type"] = "finance", ["subject_vendor_data"] = "__current__", ["currency"] = "EUR" }, }, new() { Metric = new TransactionRuleAggregationMetric("max"), Field = "amount", Operator = new TransactionRuleAggregationOperator("lt"), Value = 10000.0, Window = "30d", Filters = new Dictionary { ["direction"] = "INBOUND", ["transaction_type"] = "finance", ["subject_vendor_data"] = "__current__", ["currency"] = "EUR" }, }, }, Actions = new TransactionRuleAction[] { new() { Type = new TransactionRuleActionType("add_score"), Value = 35, }, }, }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: TransactionRuleCreateRequest: type: object required: - title - category - mode properties: title: type: string description: >- اسم القاعدة. فريد لكل تطبيق بين القواعد غير المحذوفة؛ وترجع الأسماء المكررة الرمز 400. description: type: string nullable: true category: type: string description: >- موضوع المخاطر المستخدم للتجميع وإعداد التقارير، مثل finance، وaml_ctf، وanomaly_detection، وfatf، وdevice_intelligence، وcrypto_monitoring، وtravel_rule، وresponsible_gaming، وe_commerce. mode: type: string enum: - ACTIVE - DISABLED - TEST description: >- يقوم ACTIVE بالتقييم المباشر. يقوم TEST بالتقييم وتسجيل عمليات تشغيل القواعد ولكنه لا يؤثر أبدًا في الدرجة أو الحالة - وهو وضع البدء الموصى به. يتم تخطي DISABLED. evaluation_mode: type: string enum: - ALL - ANY default: ALL description: >- ما إذا كان يجب أن يتطابق كل شرط (ALL) أو شرط واحد على الأقل (ANY). يتم تجاهله عندما تستخدم الشروط group_index. scope: $ref: '#/components/schemas/TransactionRuleScope' conditions: type: array items: $ref: '#/components/schemas/TransactionRuleCondition' aggregation: type: array items: $ref: '#/components/schemas/TransactionRuleAggregation' actions: type: array items: $ref: '#/components/schemas/TransactionRuleAction' metadata: type: object description: بيانات وصفية بصيغة حرة مخزنة في القاعدة. description: >- ينشئ قاعدة مخصصة (CUSTOM). تسري القواعد في وضع ACTIVE فوراً على المعاملات الجديدة - أنشئها في وضع TEST وأجرِ اختباراً رجعياً أولاً. TransactionRuleDetail: type: object properties: uuid: type: string format: uuid title: type: string description: >- اسم القاعدة. فريد لكل تطبيق بين القواعد غير المحذوفة؛ وترجع الأسماء المكررة الرمز 400. description: type: string nullable: true category: type: string description: >- موضوع المخاطر المستخدم للتجميع وإعداد التقارير، مثل finance، وaml_ctf، وanomaly_detection، وfatf، وdevice_intelligence، وcrypto_monitoring، وtravel_rule، وresponsible_gaming، وe_commerce. mode: type: string enum: - ACTIVE - DISABLED - TEST description: >- يقوم ACTIVE بالتقييم المباشر. يقوم TEST بالتقييم وتسجيل عمليات تشغيل القواعد ولكنه لا يؤثر أبدًا في الدرجة أو الحالة - وهو وضع البدء الموصى به. يتم تخطي DISABLED. evaluation_mode: type: string enum: - ALL - ANY default: ALL description: >- ما إذا كان يجب أن يتطابق كل شرط (ALL) أو شرط واحد على الأقل (ANY). يتم تجاهله عندما تستخدم الشروط group_index. scope: $ref: '#/components/schemas/TransactionRuleScope' conditions: type: array items: $ref: '#/components/schemas/TransactionRuleCondition' aggregation: type: array items: $ref: '#/components/schemas/TransactionRuleAggregation' actions: type: array items: $ref: '#/components/schemas/TransactionRuleAction' metadata: type: object description: بيانات وصفية بصيغة حرة مخزنة في القاعدة. severity: type: string enum: - UNKNOWN - LOW - MEDIUM - HIGH - CRITICAL nullable: true description: >- مستوى خطورة معلوماتي تحمله قواعد المكتبة؛ لا يمكن تعيينه في القواعد المخصصة. source: type: string enum: - PRESET - CUSTOM description: >- تأتي قواعد PRESET من المكتبة (تثبيت/إلغاء تثبيت، تعديلات على الوضع فقط)؛ أما قواعد CUSTOM فهي ملكك بالكامل. library_key: type: string nullable: true description: معرّف مكتبة ثابت؛ تكون القيمة null للقواعد المخصصة. latest_triggered_at: type: string format: date-time nullable: true run_count: type: integer description: عدد المعاملات التي تطابقت مع هذه القاعدة. approved_count: type: integer reviewed_count: type: integer declined_count: type: integer awaiting_user_count: type: integer approved_pct: type: number reviewed_pct: type: number declined_pct: type: number created_at: type: string format: date-time updated_at: type: string format: date-time TransactionRuleScope: type: object properties: transaction_types: type: array items: type: string description: >- التقييد بأنواع المعاملات، مثل finance أو kyc أو travel_rule أو user_event. فارغ أو مفقود = لا يوجد تقييد. directions: type: array items: type: string enum: - INBOUND - OUTBOUND description: التقييد باتجاهات المعاملات (غير حساس لحالة الأحرف عند الكتابة). action_types: type: array items: type: string description: التقييد بقيم action_type الخاصة بك، مثل withdrawal أو deposit. description: أي معاملات تنطبق عليها القاعدة. يتم قبول هذه المفاتيح الثلاثة فقط. TransactionRuleCondition: type: object required: - field - operator properties: field: type: string description: >- مسار حقل المعاملة للتقييم. الحقول الأساسية: amount، currency، direction، action_type، score، severity، transaction_type، payment_details، preferred_currency_amount (يرجع كبديل إلى amount_in_default_currency)، default_currency_code، subject_country، counterparty_country، subject_vendor_data، counterparty_vendor_data، subject_device_fingerprint، counterparty_device_fingerprint، subject_browser_family، subject_browser_version، subject_platform، subject_accept_language، subject_session_age_ms، subject_ip_country، counterparty_ip_country، subject_ip_address، counterparty_ip_address، subject_payment_method_type، subject_payment_method_country، subject_payment_method_fingerprint، subject_payment_method_account_id (وما يعادلها من counterparty_payment_method_*)، travel_rule_status، travel_rule_required، travel_rule_obligations_count، counterparty_dd_status (قرارك بشأن الطرف المقابل لـ Travel Rule: APPROVED أو RESTRICTED أو BLOCKED، وهو كيان يتبع علامته التجارية)، counterparty_risk_level (LOW أو MEDIUM أو HIGH؛ ويكون HIGH طالما كان فحص الطرف المقابل الخاص بك مُعلَّماً)، counterparty_jurisdiction (دولة VASP للطرف المقابل)، counterparty_responsiveness (RESPONSIVE أو UNRESPONSIVE أو UNKNOWN)، subject_days_since_previous_transaction، tags، و custom_values. لأي مفتاح تم إرساله في custom_properties عند إنشاء المعاملة. تقبل حقول رموز الدول كلاً من ISO-2 أو ISO-3؛ وتتم تسوية كلا الجانبين إلى ISO-3 قبل المقارنة. operator: type: string enum: - eq - ne - gt - gte - lt - lte - in - not_in - contains - not_contains - contains_any - regex - fuzzy_match - exists - is_not_empty - is_not_null - not_exists - is_empty - is_null description: >- معامل المقارنة. يختبر in/not_in الانتماء (قد تكون القيمة قائمة أو قيمة فردية واحدة). يُعد contains/not_contains فحصاً لسلسلة فرعية غير حساس لحالة الأحرف مقابل قيمة نصية. يقبل contains_any قائمة من النصوص ويتطابق عندما يكون أي منها سلسلة فرعية غير حساسة لحالة الأحرف من قيمة الحقل. يطابق regex نمط القيمة مع الحقل. يقارن fuzzy_match مع سلسلة القيمة وفقاً لحد `score` المطلوب (0-100). لا تتطابق gt/gte/lt/lte أبداً عند فقدان أي من الطرفين. تُعد exists/is_not_empty/is_not_null (أسماء مستعارة) وnot_exists/is_empty/is_null (أسماء مستعارة) فحوصات وجود تتجاهل `value`. value: description: >- قيمة المقارنة. يعتمد شكلها على المعامل وvalue_type؛ احذفها لمعاملات فحص الوجود. يحتاج كل معامل آخر إلى قيمة ليست `null` أو قائمة فارغة، وإلا فسيتم رفض القاعدة بالرمز `400`. يحتاج `contains_any` إلى قائمة نصوص، بينما يحتاج كل من `contains` و`not_contains` و`regex` إلى نص فردي. value_type: type: string enum: - list - field - relative_date description: >- تفسير اختياري للقيمة. `list`: القيمة هي UUID لقائمة وتصبح مدخلات القائمة هي قيمة المقارنة. `field`: القيمة هي مسار حقل آخر، وتتم المقارنة حقلاً بحقل. `relative_date`: القيمة هي كائن تاريخ نسبي، مثل {"direction": "past", "unit": "days", "amount": 30}. score: type: number minimum: 0 maximum: 100 description: 'مطلوب عندما يكون المشغّل هو fuzzy_match: حد التشابه بين 0 و100.' group_index: type: integer description: >- منطق مجمّع اختياري. عندما يحمل أي شرط group_index، فإن الشروط التي تشترك في نفس الفهرس تشكّل مجموعة، ويحل التقييم المجمّع محل evaluation_mode. group_logic: type: string enum: - AND - OR default: AND description: كيفية دمج الشروط داخل المجموعة الواحدة. groups_logic: type: string enum: - AND - OR default: OR description: >- كيفية دمج نتائج المجموعات عبر المجموعات المختلفة. تُقرأ من الشرط الأول. description: >- يقرأ الشرط فقط المعاملة التي تخضع للتقييم - ولا يصفّي أبداً نافذة التجميع. TransactionRuleAggregation: type: object required: - value properties: metric: type: string enum: - count - sum - max - min - avg - distinct_count default: count description: >- كيفية تجميع المعاملات السابقة المتطابقة. يتم قبول unique_count كاسم بديل لـ distinct_count. field: type: string default: amount description: >- الحقل المجمّع حسب sum/max/min/avg/distinct_count. يُتجاهل بالنسبة لـ count. operator: type: string enum: - eq - ne - gt - gte - lt - lte default: eq description: المقارنة المطبقة على المقياس المحسوب. value: type: number description: الحد الذي تتم مقارنة المقياس المحسوب به. window: type: string pattern: ^\d+(m|h|d)$ default: 1d description: >- نافذة الرجوع التي تنتهي عند txn_date الخاص بالمعاملة: m (دقائق، وليس شهوراً)، أو h (ساعات)، أو d (أيام)، مثل 30m، أو 24h، أو 7d، أو 30d. filters: type: object additionalProperties: true description: >- يُضيّق نطاق المعاملات السابقة التي يتم تجميعها. المفاتيح هي مسارات الحقول من كتالوج حقول الشروط؛ تشير القيمة "__current__" إلى قيمة الحقل نفسه في المعاملة الجاري تقييمها (على سبيل المثال، يحدد {"subject_vendor_data": "__current__"} نطاق النافذة لنفس الموضوع)، وتشير قيمة القائمة إلى الانتماء. لا يتم تجميع السجلات التي لا تحتوي على القيمة المجمعة معًا أبدًا: عندما لا تحتوي المعاملة الجاري تقييمها على قيمة لحقل "__current__" (لا يوجد طرف مقابل، ولا توجد بصمة للجهاز)، فإن التجميع لا يتطابق، أياً كان معامله. تقارن عوامل التصفية بالمساواة أو الانتماء فقط - لا توجد تصفية lt/gte، لذا لا يمكن التعبير عن نطاق مثل "المعاملات السابقة الأقل من 10,000" هنا. ضع النطاق في المقياس بدلاً من ذلك (المقياس max مع المعامل lt يحتفظ بكل معاملة في النافذة أقل من الحد). description: >- فحص معدل التكرار (velocity check) عبر المعاملات التاريخية للتطبيق داخل النافذة الزمنية. يجب أن يتطابق كل إدخال تجميعي حتى تتطابق القاعدة، بغض النظر عن evaluation_mode. يقيد التجميع النافذة الزمنية فقط؛ أما المعاملة قيد التقييم فتُقيّد بواسطة النطاق والشروط، لذا كرر direction أو currency أو transaction_type في كلا النصفين عندما تقتضي القاعدة ذلك. TransactionRuleAction: oneOf: - $ref: '#/components/schemas/TransactionRuleActionAddScore' - $ref: '#/components/schemas/TransactionRuleActionChangeStatus' - $ref: '#/components/schemas/TransactionRuleActionAddTags' - $ref: '#/components/schemas/TransactionRuleActionAddNote' - $ref: '#/components/schemas/TransactionRuleActionAddToList' - $ref: '#/components/schemas/TransactionRuleActionOpenCase' discriminator: propertyName: type mapping: add_score: '#/components/schemas/TransactionRuleActionAddScore' change_status: '#/components/schemas/TransactionRuleActionChangeStatus' add_tags: '#/components/schemas/TransactionRuleActionAddTags' add_note: '#/components/schemas/TransactionRuleActionAddNote' add_to_list: '#/components/schemas/TransactionRuleActionAddToList' open_case: '#/components/schemas/TransactionRuleActionOpenCase' description: >- إجراء قاعدة واحد. يمكن أن تحمل القاعدة عدة إجراءات؛ وتُطبّق جميعها معاً عند تطابقها. تسجل القواعد في وضع TEST ما كانت ستفعله دون تطبيق أي إجراء. TransactionRuleActionAddScore: type: object required: - type - value properties: type: type: string enum: - add_score value: type: integer description: النقاط المضافة إلى درجة المخاطر للمعاملة. قد تكون سالبة. description: >- أضف نقاطاً إلى درجة المخاطر التراكمية للمعاملة؛ يحدد الإجمالي الحالة عبر حدود المراجعة/الرفض الخاصة بالتطبيق. TransactionRuleActionChangeStatus: type: object required: - type - value properties: type: type: string enum: - change_status value: type: string enum: - APPROVED - IN_REVIEW - DECLINED - AWAITING_USER description: >- الحالة المطلوب تعيينها على الفور، بغض النظر عن النتيجة. المفتاح البديل: status. workflow_id: type: string format: uuid description: >- مطلوب عندما تكون القيمة AWAITING_USER: سير عمل التحقق الذي يُطلب من المعني إكماله. مفتاح الاسم المستعار: remediation_workflow_id. تُنشئ Didit جلسة تصحيح مستضافة للمعني عند تفعيل القاعدة. description: >- تعيين حالة المعاملة مباشرةً. تحظى DECLINED دائماً بالأولوية عبر القواعد المطابقة. TransactionRuleActionAddTags: type: object required: - type properties: type: type: string enum: - add_tags tag_uuid: type: string format: uuid description: علامة تطبيق موجودة لإرفاقها. tag_name: type: string description: >- اسم العلامة المراد إرفاقها؛ يتم إنشاؤها عند الاستخدام الأول (وتُخزّن بأحرف كبيرة). قدّم tag_uuid أو tag_name. tag_color: type: string description: >- لون سداسي عشري يُستخدم عندما ينشئ tag_name وسماً جديداً، مثل #007AFE. description: إرفاق علامة تطبيق بالمعاملة المتطابقة. TransactionRuleActionAddNote: type: object required: - type - note properties: type: type: string enum: - add_note note: type: string description: >- نص الملاحظة المرفق بالمعاملة (المؤلف: محرك القواعد). المفتاح البديل: القيمة. description: إرفاق ملاحظة محلل مؤتمتة بالمعاملة المتطابقة. TransactionRuleActionAddToList: type: object required: - type - list_id properties: type: type: string enum: - add_to_list list_id: type: string format: uuid description: القائمة المراد إضافة vendor_data الخاص بالشخص المستهدف إليها. description: >- أضف vendor_data الخاصة بالشخص الخاضع للفحص إلى قائمة الحظر، أو قائمة السماح، أو قائمة مخصصة. TransactionRuleActionOpenCase: type: object required: - type properties: type: type: string enum: - open_case blueprint: type: string format: uuid description: UUID لمخطط الحالة؛ يُعيّن افتراضياً إلى المخطط الافتراضي للتطبيق. grouping: type: string enum: - by_applicant - by_rule_and_applicant description: >- ما إذا كانت التطابقات المتكررة تنضم إلى حالة واحدة لكل متقدم أو حالة واحدة لكل قاعدة + متقدم. attach_matched_transaction: type: boolean description: إرفاق المعاملة المتطابقة بالحالة. description: >- فتح حالة تحقيق (أو الإضافة إليها). يتم تطبيق أول إجراء open_case فقط على القاعدة. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.