Obter Regra
Referência API
Obter Regra
Recuperar detalhes de uma regra específica por ID — no motor de regras gu1 para compliance e detecção de risco, com exemplos para get.
GET
Obter Regra
Visão Geral
Recupera informações completas sobre uma regra específica, incluindo suas condições, ações, estatísticas de execução e histórico de versões.Endpoint
Autenticação
Requer uma chave API válida no cabeçalho de Authorization:Parâmetros de Rota
UUID da regra a recuperar
Resposta
UUID da regra
ID da sua organização
Nome da regra
Descrição da regra
Categoria da regra (kyc, kyb, aml, fraud, compliance, custom)
Status atual (draft, active, shadow, archived, inactive)
Se a regra está habilitada
Prioridade da regra (1-100)
Pontuação de risco atribuída quando a regra corresponde
Estrutura de condições completa com lógica aninhada
Representação em string JSON das condições (para armazenamento)
Array de ações a executar quando a regra corresponde
Configuração de escopo da regra (países, tipos de entidade, janelas temporais)
Array de tipos de entidade aos quais a regra se aplica
Modo de avaliação (sync ou async)
UUID da matriz de risco associada (se houver)
Número da versão atual
UUID da versão anterior (se houver)
Array de tags para organização
Estatísticas de execução (execuções, sucessos, falhas)
ID do usuário que criou a regra
Timestamp ISO de criação
ID do usuário que atualizou a regra por último
Timestamp ISO da última atualização
Exemplos de Requisições
Exemplo de Resposta
Respostas de Erro
404 Not Found
401 Unauthorized
403 Forbidden
Casos de Uso
Exibir Detalhes da Regra na UI
Monitorar Desempenho da Regra
Clonar Configuração da Regra
Exportar Configuração da Regra
Melhores Práticas
- Cache de Dados da Regra: Fazer cache de regras acessadas frequentemente para reduzir chamadas API
- Monitorar Estatísticas: Revisar regularmente o objeto
statspara insights de desempenho - Rastrear Versões: Usar
versionepreviousVersionIdpara trilhas de auditoria - Verificar Status: Sempre verificar
enabledestatusantes da execução - Usar Tags: Aproveitar tags para organização e filtragem
Veja Também
- Listar Regras - Consultar e filtrar regras
- Atualizar Regra - Modificar configuração da regra
- Executar Regra - Testar regra contra entidades
- Criar Regra - Criar novas regras