> ## 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. # Atualizar regra de monitoramento de transações via API > Ajuste uma regra de KYT da Didit via API: limiares, condições, ações ou modo TEST, ACTIVE e DISABLED. Presets da biblioteca aceitam só o modo. Prompt da API de atualização de regra Copiar o prompt para a área de transferência \

\`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.`

\
Colar em ## OpenAPI ````yaml pt-br/openapi-25.json PATCH /v3/transactions/rules/{rule_uuid}/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de verificação de identidade. Autentique-se com o cabeçalho 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: O uuid da regra, obtido na listagem ou na criação. patch: tags: - Transactions summary: Atualizar regra description: >- Atualiza parcialmente uma regra. Regras personalizadas aceitam todos os campos de configuração. Regras da biblioteca (PRESET) aceitam apenas `mode` - use-o para ativar, desativar ou mudar uma regra predefinida para TEST; qualquer outro campo retorna 400. Uma cópia instalada de uma regra da biblioteca retida fica desligada: definir seu `mode` como qualquer valor diferente de `DISABLED` retorna 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: A regra atualizada. content: application/json: schema: $ref: '#/components/schemas/TransactionRuleDetail' '400': description: >- Erro de validação: um campo diferente de mode em uma regra da biblioteca, ou um mode diferente de DISABLED em uma regra da biblioteca retida. 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: >- Nome da regra. Único por aplicação entre as regras não excluídas; duplicatas retornam 400. description: type: string nullable: true category: type: string description: >- Tema de risco usado para agrupamento e relatórios, por exemplo 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 avalia em produção. TEST avalia e registra as execuções de regras, mas nunca altera a pontuação nem o status - o modo inicial recomendado. DISABLED é ignorado. evaluation_mode: type: string enum: - ALL - ANY default: ALL description: >- Indica se todas as condições devem corresponder (ALL) ou pelo menos uma (ANY). Ignorado quando as condições usam 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: Metadados livres armazenados na regra. description: >- Atualização parcial. Regras personalizadas aceitam todos os campos; regras da biblioteca (PRESET) aceitam apenas mode, e qualquer outro campo retorna 400. TransactionRuleDetail: type: object properties: uuid: type: string format: uuid title: type: string description: >- Nome da regra. Único por aplicação entre as regras não excluídas; duplicatas retornam 400. description: type: string nullable: true category: type: string description: >- Tema de risco usado para agrupamento e relatórios, por exemplo 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 avalia em produção. TEST avalia e registra as execuções de regras, mas nunca altera a pontuação nem o status - o modo inicial recomendado. DISABLED é ignorado. evaluation_mode: type: string enum: - ALL - ANY default: ALL description: >- Indica se todas as condições devem corresponder (ALL) ou pelo menos uma (ANY). Ignorado quando as condições usam 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: Metadados livres armazenados na regra. severity: type: string enum: - UNKNOWN - LOW - MEDIUM - HIGH - CRITICAL nullable: true description: >- Severidade informativa usada pelas regras da biblioteca; não pode ser definida em regras personalizadas. source: type: string enum: - PRESET - CUSTOM description: >- As regras PRESET vêm da biblioteca (instalar/desinstalar, edições apenas do modo); as regras CUSTOM são inteiramente suas. library_key: type: string nullable: true description: >- Identificador estável da biblioteca; null para regras personalizadas. latest_triggered_at: type: string format: date-time nullable: true run_count: type: integer description: Quantas transações corresponderam a esta regra. 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: >- Restringe a tipos de transação, por exemplo finance, kyc, travel_rule, user_event. Vazio ou ausente = sem restrição. directions: type: array items: type: string enum: - INBOUND - OUTBOUND description: >- Restringe a direções de transação (sem distinção entre maiúsculas e minúsculas na gravação). action_types: type: array items: type: string description: >- Restringe aos seus valores de action_type, por exemplo withdrawal, deposit. description: >- A quais transações a regra se aplica. Somente estas três chaves são aceitas. TransactionRuleCondition: type: object required: - field - operator properties: field: type: string description: >- Caminho do campo da transação a ser avaliado. Campos principais: amount, currency, direction, action_type, score, severity, transaction_type, payment_details, preferred_currency_amount (usa amount_in_default_currency como alternativa), 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 (e os equivalentes counterparty_payment_method_*), travel_rule_status, travel_rule_required, travel_rule_obligations_count, counterparty_dd_status (sua decisão sobre a contraparte da Travel Rule: APPROVED, RESTRICTED ou BLOCKED; uma entidade segue a decisão da sua marca), counterparty_risk_level (LOW, MEDIUM ou HIGH; HIGH enquanto a sua própria triagem da contraparte estiver sinalizada), counterparty_jurisdiction (o país do VASP da contraparte), counterparty_responsiveness (RESPONSIVE, UNRESPONSIVE ou UNKNOWN), subject_days_since_previous_transaction, tags e custom_values. para qualquer chave enviada em custom_properties na criação da transação. Campos de código de país aceitam ISO-2 ou ISO-3; ambos os lados são normalizados para ISO-3 antes da comparação. 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: >- Operador de comparação. in/not_in testam pertencimento (o valor pode ser uma lista ou um único escalar). contains/not_contains verificam, sem diferenciar maiúsculas de minúsculas, se uma substring está contida em um valor de texto. contains_any recebe uma lista de strings e corresponde quando qualquer uma delas é uma substring do valor do campo, sem diferenciar maiúsculas de minúsculas. regex compara o padrão do valor com o campo. fuzzy_match compara com a string do valor usando o limiar `score` exigido (0-100). gt/gte/lt/lte nunca correspondem quando um dos lados está ausente. exists/is_not_empty/is_not_null (aliases) e not_exists/is_empty/is_null (aliases) são verificações de presença que ignoram `value`. value: description: >- Valor de comparação. Seu formato depende do operador e de value_type; omita-o nos operadores de verificação de presença. Todos os outros operadores exigem um valor que não seja `null` nem uma lista vazia; caso contrário, a regra é recusada com `400`. `contains_any` exige uma lista de strings, e `contains`, `not_contains` e `regex` exigem uma única string. value_type: type: string enum: - list - field - relative_date description: >- Interpretação opcional do valor. `list`: o valor é o UUID de uma lista, e as entradas da lista passam a ser o valor de comparação. `field`: o valor é o caminho de outro campo, comparado campo a campo. `relative_date`: o valor é um objeto de data relativa, por exemplo {"direction": "past", "unit": "days", "amount": 30}. score: type: number minimum: 0 maximum: 100 description: >- Obrigatório quando o operator for fuzzy_match: o limiar de similaridade de 0 a 100. group_index: type: integer description: >- Lógica agrupada opcional. Quando alguma condição tiver group_index, as condições que compartilham um índice formam um grupo, e a avaliação agrupada substitui evaluation_mode. group_logic: type: string enum: - AND - OR default: AND description: Como as condições se combinam DENTRO de um grupo. groups_logic: type: string enum: - AND - OR default: OR description: >- Como os resultados dos grupos se combinam ENTRE os grupos. Lido a partir da primeira condição. description: >- Uma condição lê apenas a transação que está sendo avaliada - ela nunca filtra a janela de agregação. TransactionRuleAggregation: type: object required: - value properties: metric: type: string enum: - count - sum - max - min - avg - distinct_count default: count description: >- Como as transações históricas correspondentes são agregadas. unique_count é aceito como alias de distinct_count. field: type: string default: amount description: >- Campo agregado por sum/max/min/avg/distinct_count. Ignorado para count. operator: type: string enum: - eq - ne - gt - gte - lt - lte default: eq description: Comparação aplicada à métrica calculada. value: type: number description: Limiar com o qual a métrica calculada é comparada. window: type: string pattern: ^\d+(m|h|d)$ default: 1d description: >- Janela retroativa que termina na txn_date da transação: m (MINUTOS, não meses), h (horas) ou d (dias), por exemplo, 30m, 24h, 7d, 30d. filters: type: object additionalProperties: true description: >- Restringe quais transações históricas são agregadas. As chaves são caminhos de campo do catálogo de campos de condição; um valor "__current__" é resolvido para o valor do mesmo campo na transação que está sendo avaliada (por exemplo, {"subject_vendor_data": "__current__"} limita a janela ao mesmo titular), e um valor em lista significa pertencimento. Os filtros comparam SOMENTE por igualdade ou pertencimento: não existe filtro lt/gte, portanto um intervalo como "transações históricas abaixo de 10,000" não pode ser expresso aqui. Em vez disso, coloque o intervalo na métrica (a métrica max com o operador lt mantém todas as transações da janela abaixo do limiar). description: >- Verificação de velocidade sobre as transações históricas da aplicação dentro da janela. Todas as entradas de agregação devem corresponder para que a regra corresponda, independentemente de evaluation_mode. Uma agregação restringe apenas a janela; a transação em avaliação é restringida por scope e conditions, portanto repita direction, currency ou transaction_type nas duas partes quando a regra os garantir. 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: >- Uma ação de regra. Uma regra pode ter várias; todas são aplicadas juntas quando ela corresponde. Regras no modo TEST registram o que teriam feito sem aplicar nenhuma ação. TransactionRuleActionAddScore: type: object required: - type - value properties: type: type: string enum: - add_score value: type: integer description: >- Pontos adicionados à pontuação de risco da transação. Pode ser negativo. description: >- Adiciona pontos à pontuação de risco acumulada da transação; o total define o status com base nos limiares de revisão/recusa da aplicação. 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 a definir imediatamente, independentemente da pontuação. Chave alternativa: status. workflow_id: type: string format: uuid description: >- OBRIGATÓRIO quando o valor for AWAITING_USER: o fluxo de verificação que o titular deve concluir. Chave alternativa: remediation_workflow_id. A Didit cria uma sessão de remediação hospedada para o titular quando a regra é acionada. description: >- Define diretamente o status da transação. DECLINED sempre prevalece entre as regras correspondentes. TransactionRuleActionAddTags: type: object required: - type properties: type: type: string enum: - add_tags tag_uuid: type: string format: uuid description: Tag existente da aplicação a ser associada. tag_name: type: string description: >- Nome da tag a anexar; criada no primeiro uso (armazenada em maiúsculas). Informe tag_uuid ou tag_name. tag_color: type: string description: >- Cor hexadecimal usada quando tag_name cria uma nova tag, por exemplo, #007AFE. description: Anexe uma tag da aplicação à transação correspondente. TransactionRuleActionAddNote: type: object required: - type - note properties: type: type: string enum: - add_note note: type: string description: >- Texto da nota anexada à transação (autor: Rule Engine). Chave alternativa: value. description: Anexe uma nota automatizada de analista à transação correspondente. TransactionRuleActionAddToList: type: object required: - type - list_id properties: type: type: string enum: - add_to_list list_id: type: string format: uuid description: Lista à qual o vendor_data do sujeito será adicionado. description: >- Adiciona o vendor_data do titular a uma lista de bloqueio, lista de permissões ou lista personalizada. TransactionRuleActionOpenCase: type: object required: - type properties: type: type: string enum: - open_case blueprint: type: string format: uuid description: >- UUID do modelo de caso; o padrão é o modelo de caso padrão da aplicação. grouping: type: string enum: - by_applicant - by_rule_and_applicant description: >- Indica se correspondências repetidas se agrupam em um caso por solicitante ou em um caso por regra+solicitante. attach_matched_transaction: type: boolean description: Anexe a transação correspondente ao caso. description: >- Abre (ou adiciona a) um caso de investigação. Apenas a primeira ação open_case de uma regra é aplicada. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.