> ## 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.
# Actualitzar regla de monitoratge de transaccions API
> Ajusta una regla KYT amb l'API de Didit: llindars, condicions, accions o mode (TEST, ACTIVE, DISABLED). Els presets només admeten el mode.
Prompt de l'API per actualitzar una regla
Copia el prompt al porta-retalls
\
\`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.`
\
Enganxa a
## OpenAPI
````yaml ca/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 verificació d'identitat. Autentica't amb la capçalera 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: L'uuid de la regla obtingut en llistar o crear.
patch:
tags:
- Transactions
summary: Actualitza la regla
description: >-
Actualitza parcialment una regla. Les regles personalitzades accepten
tots els camps de configuració. Les regles de la biblioteca (PRESET)
només accepten `mode`: utilitza'l per activar, desactivar o canviar un
valor predefinit a TEST; qualsevol altre camp retorna 400, perquè Didit
manté les regles de la biblioteca i n'aplica les actualitzacions
automàticament. Per canviar les condicions d'una regla de la biblioteca,
crea una còpia personalitzada amb `POST /v3/transactions/rules/`
utilitzant la definició de la regla de la biblioteca i
`metadata.based_on` (la clau de la biblioteca) i
`metadata.based_on_rule_uuid`, i després desactiva la regla de la
biblioteca amb `mode: DISABLED` perquè una transacció no alerti dues
vegades. Una còpia instal·lada d'una regla de la biblioteca retinguda es
desactiva: establir el seu `mode` en qualsevol valor que no sigui
`DISABLED` retorna 400 ("Aquesta regla de la biblioteca encara no es pot
executar: les seves condicions llegeixen dades que el motor de regles no
pot avaluar.").
operationId: updateTransactionRule
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionRuleUpdateRequest'
example:
mode: ACTIVE
responses:
'200':
description: La regla actualitzada.
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionRuleDetail'
'400':
description: >-
Error de validació, un camp que no és de mode en una regla de
biblioteca o un mode diferent de DISABLED en una regla de biblioteca
retinguda.
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: >-
Nom de la regla. Únic per aplicació entre les regles no eliminades;
els duplicats retornen 400.
description:
type: string
nullable: true
category:
type: string
description: >-
Tema de risc utilitzat per agrupar i generar informes, p. ex.,
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 avalua en temps real. TEST avalua i registra les execucions
de regles però mai no modifica la puntuació ni l'estat: el mode
inicial recomanat. DISABLED s'omet.
evaluation_mode:
type: string
enum:
- ALL
- ANY
default: ALL
description: >-
Indica si s'han de complir totes les condicions (ALL) o com a mínim
una (ANY). S'ignora quan les condicions utilitzen 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: Metadades de format lliure emmagatzemades a la regla.
description: >-
Actualització parcial. Les regles personalitzades accepten tots els
camps; les regles de la biblioteca (PRESET) només accepten mode;
qualsevol altra opció retorna 400.
TransactionRuleDetail:
type: object
properties:
uuid:
type: string
format: uuid
title:
type: string
description: >-
Nom de la regla. Únic per aplicació entre les regles no eliminades;
els duplicats retornen 400.
description:
type: string
nullable: true
category:
type: string
description: >-
Tema de risc utilitzat per agrupar i generar informes, p. ex.,
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 avalua en temps real. TEST avalua i registra les execucions
de regles però mai no modifica la puntuació ni l'estat: el mode
inicial recomanat. DISABLED s'omet.
evaluation_mode:
type: string
enum:
- ALL
- ANY
default: ALL
description: >-
Indica si s'han de complir totes les condicions (ALL) o com a mínim
una (ANY). S'ignora quan les condicions utilitzen 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: Metadades de format lliure emmagatzemades a la regla.
severity:
type: string
enum:
- UNKNOWN
- LOW
- MEDIUM
- HIGH
- CRITICAL
nullable: true
description: >-
Gravetat informativa transmesa per les regles de la biblioteca; no
es pot configurar en regles personalitzades.
source:
type: string
enum:
- PRESET
- CUSTOM
description: >-
Les regles PRESET provenen de la biblioteca
(instal·lació/desinstal·lació, modificacions només de mode); les
regles CUSTOM són totalment teves.
library_key:
type: string
nullable: true
description: >-
Identificador de biblioteca estable; null per a regles
personalitzades.
latest_triggered_at:
type: string
format: date-time
nullable: true
run_count:
type: integer
description: Quantes transaccions han coincidit amb aquesta regla.
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: >-
Restringeix als tipus de transacció, p. ex. finance, kyc,
travel_rule, user_event. Buit o absent = sense restricció.
directions:
type: array
items:
type: string
enum:
- INBOUND
- OUTBOUND
description: >-
Restringeix a direccions de transacció (no distingeix majúscules de
minúscules en escriure).
action_types:
type: array
items:
type: string
description: >-
Restringeix als teus valors de action_type, p. ex. withdrawal,
deposit.
description: >-
A quines transaccions s'aplica la regla. Només s'accepten aquestes tres
claus.
TransactionRuleCondition:
type: object
required:
- field
- operator
properties:
field:
type: string
description: >-
Ruta del camp de la transacció que s'ha d'avaluar. Camps principals:
amount, currency, direction, action_type, score, severity,
transaction_type, payment_details, preferred_currency_amount
(recorre a amount_in_default_currency si no està definit),
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 (i els equivalents
counterparty_payment_method_*), travel_rule_status,
travel_rule_required, travel_rule_obligations_count,
counterparty_dd_status (la teva decisió sobre la contrapart de
Travel Rule: APPROVED, RESTRICTED o BLOCKED, una entitat que segueix
la decisió de la seva marca), counterparty_risk_level (LOW, MEDIUM o
HIGH; HIGH mentre el teu propi cribratge de contraparts estigui
marcat), counterparty_jurisdiction (el país del VASP de la
contrapart), counterparty_responsiveness (RESPONSIVE, UNRESPONSIVE o
UNKNOWN), subject_days_since_previous_transaction, tags i
custom_values. per a qualsevol clau enviada a custom_properties
en crear la transacció. Els camps de codi de país accepten ISO-2 o
ISO-3; ambdues parts es normalitzen a ISO-3 abans de la comparació.
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 comparació. in/not_in comproven la pertinença (el valor
pot ser una llista o un únic escalar). contains/not_contains són
comprovacions de subcadenes que no distingeixen majúscules de
minúscules respecte a un valor de tipus cadena. contains_any rep una
llista de cadenes i coincideix quan qualsevol d'elles és una
subcadena (sense distingir majúscules de minúscules) del valor del
camp. regex compara el patró del valor amb el camp. fuzzy_match
compara amb la cadena del valor mitjançant el llindar `score`
requerit (0-100). gt/gte/lt/lte mai no coincideixen quan falta algun
dels dos costats. exists/is_not_empty/is_not_null (àlies) i
not_exists/is_empty/is_null (àlies) són comprovacions de presència
que ignoren `value`.
value:
description: >-
Valor de comparació. La seva estructura depèn de l'operador i de
value_type; omet-lo per als operadors de comprovació de presència.
Qualsevol altre operador necessita un valor que no sigui `null` ni
una llista buida; en cas contrari, la regla es rebutja amb `400`.
`contains_any` necessita una llista de cadenes, i `contains`,
`not_contains` i `regex` necessiten una sola cadena.
value_type:
type: string
enum:
- list
- field
- relative_date
description: >-
Interpretació opcional del valor. `list`: el valor és un UUID de
llista i les entrades de la llista esdevenen el valor de comparació.
`field`: el valor és una altra ruta de camp, comparada camp a camp.
`relative_date`: el valor és un objecte de data relativa, p. ex.
{"direction": "past", "unit": "days", "amount": 30}.
score:
type: number
minimum: 0
maximum: 100
description: >-
Obligatori quan operator és fuzzy_match: el llindar de similitud de
0-100.
group_index:
type: integer
description: >-
Lògica agrupada opcional. Quan qualsevol condició té group_index,
les condicions que comparteixen un índex formen un grup i
l'avaluació agrupada substitueix evaluation_mode.
group_logic:
type: string
enum:
- AND
- OR
default: AND
description: Com es combinen les condicions DINS d'un grup.
groups_logic:
type: string
enum:
- AND
- OR
default: OR
description: >-
Com es combinen els resultats dels grups ENTRE grups. Es llegeix a
partir de la primera condició.
description: >-
Una condició només llegeix la transacció que s'està avaluant; mai filtra
la finestra d'agregació.
TransactionRuleAggregation:
type: object
required:
- value
properties:
metric:
type: string
enum:
- count
- sum
- max
- min
- avg
- distinct_count
default: count
description: >-
Com s'agreguen les transaccions històriques coincidents. S'accepta
unique_count com a àlies de distinct_count.
field:
type: string
default: amount
description: >-
Camp agregat per sum/max/min/avg/distinct_count. S'ignora per a
count.
operator:
type: string
enum:
- eq
- ne
- gt
- gte
- lt
- lte
default: eq
description: Comparació aplicada a la mètrica calculada.
value:
type: number
description: Llindar amb el qual es compara la mètrica calculada.
window:
type: string
pattern: ^\d+(m|h|d)$
default: 1d
description: >-
Finestra retrospectiva que finalitza al camp txn_date de la
transacció: m (MINUTS, no mesos), h (hores) o d (dies), p.
ex. 30m, 24h, 7d, 30d.
filters:
type: object
additionalProperties: true
description: >-
Restringeix quines transaccions històriques s'agreguen. Les claus
són rutes de camps del catàleg de camps de condicions; un valor de
"__current__" es resol al valor del mateix camp a la transacció que
s'està avaluant (p. ex., {"subject_vendor_data": "__current__"}
limita la finestra al mateix subjecte), i un valor de llista indica
pertinença. Els registres sense el valor agrupat mai no s'agrupen
junts: quan la transacció que s'està avaluant no té cap valor per a
un camp "__current__" (sense contrapart, sense empremta digital del
dispositiu), l'agregació no coincideix, sigui quin sigui el seu
operador. Els filtres comparen NOMÉS per igualtat o pertinença; no
hi ha cap filtre lt/gte, de manera que un interval com ara
"transaccions històriques inferiors a 10.000" no es pot expressar
aquí. En comptes d'això, posa l'interval a la mètrica (la mètrica
max amb l'operador lt manté totes les transaccions de la finestra
per sota del llindar).
description: >-
Comprovació de velocitat sobre les transaccions històriques de
l'aplicació dins de la finestra temporal. Cada entrada d'agregació ha de
coincidir perquè la regla coincideixi, independentment de
evaluation_mode. Una agregació limita només la finestra temporal; la
transacció que s'està avaluant està limitada per scope i conditions, per
la qual cosa cal repetir direction, currency o transaction_type a totes
dues meitats quan la regla els requereixi.
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: >-
Una acció de regla. Una regla en pot incloure diverses; totes s'apliquen
conjuntament quan coincideix. Les regles en mode TEST registren el que
haurien fet sense aplicar cap acció.
TransactionRuleActionAddScore:
type: object
required:
- type
- value
properties:
type:
type: string
enum:
- add_score
value:
type: integer
description: >-
Punts afegits a la puntuació de risc de la transacció. Poden ser
negatius.
description: >-
Afegeix punts a la puntuació de risc acumulada de la transacció; el
total decideix l'estat mitjançant els llindars de revisió/rebuig de
l'aplicació.
TransactionRuleActionChangeStatus:
type: object
required:
- type
- value
properties:
type:
type: string
enum:
- change_status
value:
type: string
enum:
- APPROVED
- IN_REVIEW
- DECLINED
- AWAITING_USER
description: >-
Estat a establir immediatament, independentment de la puntuació.
Clau d'àlies: status.
workflow_id:
type: string
format: uuid
description: >-
OBLIGATORI quan el valor és AWAITING_USER: el flux de treball de
verificació que el subjecte ha de completar. Clau d'àlies:
remediation_workflow_id. Didit crea una sessió de resolució
allotjada per al subjecte quan s'activa la regla.
description: >-
Estableix directament l'estat de la transacció. DECLINED sempre preval
entre les regles coincidents.
TransactionRuleActionAddTags:
type: object
required:
- type
properties:
type:
type: string
enum:
- add_tags
tag_uuid:
type: string
format: uuid
description: Etiqueta d'aplicació existent per adjuntar.
tag_name:
type: string
description: >-
Nom de l'etiqueta per adjuntar; es crea amb el primer ús
(s'emmagatzema en majúscules). Proporciona tag_uuid o tag_name.
tag_color:
type: string
description: >-
Color hexadecimal utilitzat quan tag_name crea una etiqueta nova, p.
ex. #007AFE.
description: Adjunta una etiqueta d'aplicació a la transacció coincident.
TransactionRuleActionAddNote:
type: object
required:
- type
- note
properties:
type:
type: string
enum:
- add_note
note:
type: string
description: >-
Text de la nota adjunt a la transacció (autor: Rule Engine). Clau
d'àlies: valor.
description: Adjunta una nota d'analista automatitzada a la transacció coincident.
TransactionRuleActionAddToList:
type: object
required:
- type
- list_id
properties:
type:
type: string
enum:
- add_to_list
list_id:
type: string
format: uuid
description: Llista a la qual s'ha d'afegir el vendor_data del subjecte.
description: >-
Afegeix el vendor_data del subjecte a una llista de bloqueig, llista
d'admesos o llista personalitzada.
TransactionRuleActionOpenCase:
type: object
required:
- type
properties:
type:
type: string
enum:
- open_case
blueprint:
type: string
format: uuid
description: >-
UUID del blueprint del cas; per defecte s'utilitza el blueprint per
defecte de l'aplicació.
grouping:
type: string
enum:
- by_applicant
- by_rule_and_applicant
description: >-
Indica si les coincidències repetides s'associen a un únic cas per
sol·licitant o a un per regla+sol·licitant.
attach_matched_transaction:
type: boolean
description: Adjunta la transacció coincident al cas.
description: >-
Obre (o afegeix a) un cas d'investigació. Només s'aplica la primera
acció open_case d'una regla.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
La clau d'API de la teva aplicació, des de Developers -> API keys a la
Business Console. La clau primària té accés complet. Una clau amb nom
pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
limitada a determinats fluxos de treball o a sessions aprovades, a una
llista d'adreces IP i a una data de caducitat. 401 significa que la clau
és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
clau, que la clau no té accés a aquest recurs o acció, o que la
sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
ruta de sessió significa que la sessió està fora dels fluxos de treball
o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
URL d'imatge, vídeo i PDF com a null, i una clau sense permís
d'escriptura de sessions rep els enllaços de sessió i els tokens com a
null. Consulta https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.