Pular para o conteúdo principal
GET
curl

Autorizações

x-api-key
string
header
obrigatório

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.

Parâmetros de caminho

rule_uuid
string<uuid>
obrigatório

O uuid da regra, obtido na listagem ou na criação.

Resposta

A regra.

uuid
string<uuid>
title
string

Nome da regra. Único por aplicação entre as regras não excluídas; duplicatas retornam 400.

description
string | null
category
string

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

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.

Opções disponíveis:
ACTIVE,
DISABLED,
TEST
evaluation_mode
enum<string>
padrão:ALL

Indica se todas as condições devem corresponder (ALL) ou pelo menos uma (ANY). Ignorado quando as condições usam group_index.

Opções disponíveis:
ALL,
ANY
scope
object

A quais transações a regra se aplica. Somente estas três chaves são aceitas.

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

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.

metadata
object

Metadados livres armazenados na regra.

severity
enum<string> | null

Severidade informativa usada pelas regras da biblioteca; não pode ser definida em regras personalizadas.

Opções disponíveis:
UNKNOWN,
LOW,
MEDIUM,
HIGH,
CRITICAL
source
enum<string>

As regras PRESET vêm da biblioteca (instalar/desinstalar, edições apenas do modo); as regras CUSTOM são inteiramente suas.

Opções disponíveis:
PRESET,
CUSTOM
library_key
string | null

Identificador estável da biblioteca; null para regras personalizadas.

latest_triggered_at
string<date-time> | null
run_count
integer

Quantas transações corresponderam a esta regra.

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 modificação em 1 de novembro de 2026