Passer au contenu principal
GET
curl

Autorisations

x-api-key
string
header
requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

Paramètres de chemin

rule_uuid
string<uuid>
requis

L'uuid de la règle issu de la liste ou de la création.

Réponse

La règle.

uuid
string<uuid>
title
string

Nom de la règle. Unique par application parmi les règles non supprimées ; les doublons renvoient 400.

description
string | null
category
string

Thématique de risque utilisée pour le regroupement et les rapports, par ex. finance, aml_ctf, anomaly_detection, fatf, device_intelligence, crypto_monitoring, travel_rule, responsible_gaming, e_commerce.

mode
enum<string>

ACTIVE évalue en direct. TEST évalue et enregistre les exécutions de règles mais ne modifie jamais le score ni le statut - le mode de départ recommandé. DISABLED est ignoré.

Options disponibles:
ACTIVE,
DISABLED,
TEST
evaluation_mode
enum<string>
défaut:ALL

Indique si chaque condition doit correspondre (ALL) ou au moins une (ANY). Ignoré lorsque les conditions utilisent group_index.

Options disponibles:
ALL,
ANY
scope
object

À quelles transactions la règle s'applique. Seules ces trois clés sont acceptées.

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

Une action de règle. Une règle peut en comporter plusieurs ; elles sont toutes appliquées ensemble lorsqu'elle correspond. Les règles en mode TEST enregistrent ce qu'elles auraient fait sans appliquer aucune action.

metadata
object

Métadonnées libres stockées sur la règle.

severity
enum<string> | null

Gravité informative portée par les règles de la bibliothèque ; non définissable sur les règles personnalisées.

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

Les règles PRESET proviennent de la bibliothèque (installation/désinstallation, modifications du mode uniquement) ; les règles CUSTOM sont entièrement les vôtres.

Options disponibles:
PRESET,
CUSTOM
library_key
string | null

Identifiant stable de bibliothèque ; null pour les règles personnalisées.

latest_triggered_at
string<date-time> | null
run_count
integer

Nombre de transactions correspondant à cette règle.

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>
Dernière modification le 7 novembre 2026