Saltar al contenido principal
GET
curl

Autorizaciones

x-api-key
string
header
requerido

La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Parámetros de ruta

rule_uuid
string<uuid>
requerido

El uuid de la regla, obtenido al listarla o crearla.

Respuesta

La regla.

uuid
string<uuid>
title
string

Nombre de la regla. Único por aplicación entre las reglas no eliminadas; los duplicados devuelven 400.

description
string | null
category
string

Tema de riesgo que se usa para agrupar y generar informes, p. ej., finance, aml_ctf, anomaly_detection, fatf, device_intelligence, crypto_monitoring, travel_rule, responsible_gaming, e_commerce.

mode
enum<string>

ACTIVE evalúa en vivo. TEST evalúa y registra las ejecuciones de reglas, pero nunca modifica la puntuación ni el estado: es el modo inicial recomendado. DISABLED se omite.

Opciones disponibles:
ACTIVE,
DISABLED,
TEST
evaluation_mode
enum<string>
predeterminado:ALL

Indica si deben cumplirse todas las condiciones (ALL) o al menos una (ANY). Se ignora cuando las condiciones usan group_index.

Opciones disponibles:
ALL,
ANY
scope
object

A qué transacciones se aplica la regla. Solo se aceptan estas tres claves.

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

Una acción de regla. Una regla puede tener varias; todas se aplican a la vez cuando la regla coincide. Las reglas en modo TEST registran lo que habrían hecho sin aplicar ninguna acción.

metadata
object

Metadatos libres guardados en la regla.

severity
enum<string> | null

Gravedad informativa que incluyen las reglas de la biblioteca; no se puede establecer en reglas personalizadas.

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

Las reglas PRESET provienen de la biblioteca (instalar/desinstalar, ediciones solo del modo); las reglas CUSTOM son completamente tuyas.

Opciones disponibles:
PRESET,
CUSTOM
library_key
string | null

Identificador estable de la biblioteca; null para reglas personalizadas.

latest_triggered_at
string<date-time> | null
run_count
integer

Cuántas transacciones coincidieron con esta 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>
Última modificación el 1 de noviembre de 2026