Saltar al contingut principal
POST
curl

Autoritzacions

x-api-key
string
header
requerit

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.

Cos

application/json

Crea una regla CUSTOM. Les regles en mode ACTIVE tenen efecte immediatament per a les noves transaccions; crea-la en mode TEST i fes un backtest primer.

title
string
requerit

Nom de la regla. Únic per aplicació entre les regles no eliminades; els duplicats retornen 400.

category
string
requerit

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
enum<string>
requerit

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.

Opcions disponibles:
ACTIVE,
DISABLED,
TEST
description
string | null
evaluation_mode
enum<string>
predeterminat:ALL

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.

Opcions disponibles:
ALL,
ANY
scope
object

A quines transaccions s'aplica la regla. Només s'accepten aquestes tres claus.

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

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ó.

metadata
object

Metadades de format lliure emmagatzemades a la regla.

Resposta

La regla creada.

uuid
string<uuid>
title
string

Nom de la regla. Únic per aplicació entre les regles no eliminades; els duplicats retornen 400.

description
string | null
category
string

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
enum<string>

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.

Opcions disponibles:
ACTIVE,
DISABLED,
TEST
evaluation_mode
enum<string>
predeterminat:ALL

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.

Opcions disponibles:
ALL,
ANY
scope
object

A quines transaccions s'aplica la regla. Només s'accepten aquestes tres claus.

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

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ó.

metadata
object

Metadades de format lliure emmagatzemades a la regla.

severity
enum<string> | null

Gravetat informativa transmesa per les regles de la biblioteca; no es pot configurar en regles personalitzades.

Opcions disponibles:
UNKNOWN,
LOW,
MEDIUM,
HIGH,
CRITICAL
source
enum<string>

Les regles PRESET provenen de la biblioteca (instal·lació/desinstal·lació, modificacions només de mode); les regles CUSTOM són totalment teves.

Opcions disponibles:
PRESET,
CUSTOM
library_key
string | null

Identificador de biblioteca estable; null per a regles personalitzades.

latest_triggered_at
string<date-time> | null
run_count
integer

Quantes transaccions han coincidit amb aquesta regla.

approved_count
integer
reviewed_count
integer
declined_count
integer
awaiting_user_count
integer
approved_pct
number
reviewed_pct
number
declined_pct
number
created_at
string<date-time>
updated_at
string<date-time>
Darrera modificació el 7 de novembre del 2026