> ## 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 в Didit через API: пороги, условия, действия или режим TEST, ACTIVE, DISABLED. Готовые пресеты принимают только режим. Промпт для API обновления правила Скопировать промпт в буфер обмена \

\`Update a transaction-monitoring rule.

Endpoint:
PATCH https://verification.didit.me/v3/transactions/rules/{rule_uuid}/

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

Request body (application/json, partial - send only what changes):
\{ "mode": "ACTIVE" }
or any of: title, description, category, mode, evaluation_mode, scope, conditions, aggregation, actions, metadata.

Behavior:
\- CUSTOM rules accept every field, with the same validation as create.
\- Library (PRESET) rules accept ONLY "mode" - use it to activate, disable, or switch a preset to TEST. Any other field returns 400 naming the offending keys.
\- Changes take effect immediately for new transactions.
\- The typical activation call after a successful backtest is exactly {"mode": "ACTIVE"}.

Failure modes:
\- 400 - validation error, or a non-mode field on a library rule.
\- 404 - unknown rule uuid for this application.`

\
Вставьте в ## OpenAPI ````yaml ru/openapi-25.json PATCH /v3/transactions/rules/{rule_uuid}/ 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/{rule_uuid}/: parameters: - name: rule_uuid in: path required: true schema: type: string format: uuid description: UUID правила из вызова list или create. patch: tags: - Transactions summary: Обновить правило description: >- Частично обновить правило. Пользовательские правила принимают любые поля конфигурации. Библиотечные правила (PRESET) принимают только `mode`: используйте его для активации, отключения или перевода предустановленного правила в режим TEST; любое другое поле возвращает 400, так как Didit поддерживает библиотечные правила и применяет их обновления автоматически. Чтобы изменить условия библиотечного правила, создайте пользовательскую копию с помощью `POST /v3/transactions/rules/`, используя определение библиотечного правила, а также `metadata.based_on` (ключ библиотеки) и `metadata.based_on_rule_uuid`, затем отключите библиотечное правило с помощью `mode: DISABLED`, чтобы по транзакции не создавалось повторное оповещение. Установленная копия скрытого библиотечного правила отключена: установка для `mode` любого значения, кроме `DISABLED`, возвращает 400 ("This library rule cannot run yet: its conditions read data the rules engine cannot evaluate."). operationId: updateTransactionRule requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TransactionRuleUpdateRequest' example: mode: ACTIVE responses: '200': description: Обновлённое правило. content: application/json: schema: $ref: '#/components/schemas/TransactionRuleDetail' '400': description: >- Ошибка валидации, поле, не относящееся к режиму, в библиотечном правиле или режим, отличный от DISABLED, в библиотечном правиле, для которого установлен статус withheld. content: application/json: schema: type: object security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X PATCH 'https://verification.didit.me/v3/transactions/rules/RULE_UUID/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"mode": "ACTIVE"}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.transactions.rules.update( "11111111-2222-3333-4444-555555555555", mode="ACTIVE", ) 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.update("11111111-2222-3333-4444-555555555555", { mode: "ACTIVE", }); 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.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TransactionRuleUpdateRequest{\n\tMode: didit.Some(didit.TransactionRuleUpdateRequestMode(\"ACTIVE\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import me.didit.Didit; import me.didit.types.TransactionRuleUpdateRequest; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.transactions().rules().update("11111111-2222-3333-4444-555555555555", TransactionRuleUpdateRequest.builder() .mode(TransactionRuleUpdateRequest.Mode.of("ACTIVE")) .build()); System.out.println(result); - lang: php label: PHP source: >- transactions->rules->update('11111111-2222-3333-4444-555555555555', [ 'mode' => 'ACTIVE', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.transactions.rules.update( "11111111-2222-3333-4444-555555555555", mode: "ACTIVE" ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Transactions.Rules.UpdateAsync("11111111-2222-3333-4444-555555555555", new TransactionRuleUpdateRequest { Mode = new TransactionRuleUpdateRequestMode("ACTIVE"), }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: TransactionRuleUpdateRequest: type: object 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: >- Частичное обновление. Пользовательские правила принимают любые поля; правила из библиотеки (PRESET) принимают только mode - любые другие параметры возвращают 400. 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: >- Обязательно, когда operator имеет значение 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. Агрегация ограничивает только окно; оцениваемая транзакция ограничивается областью (scope) и условиями, поэтому дублируйте 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: >- Шестнадцатеричный цвет (hex), используемый, когда tag_name создаёт новый тег, например #007AFE. description: Прикрепить тег приложения к совпавшей транзакции. TransactionRuleActionAddNote: type: object required: - type - note properties: type: type: string enum: - add_note note: type: string description: >- Текст заметки, прикреплённой к транзакции (автор: Rule Engine). Ключ-алиас: значение. 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-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.