> ## Documentation Index
> Fetch the complete documentation index at: https://docs-platform.services-valid.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# O que são eventos

> Sinais de risco identificados na consulta, como configurar o nível de cada um e como o Perfil de risco é calculado.

Um **evento** é um sinal identificado durante a consulta sobre a pessoa ou empresa. Exemplos: CPF irregular, pessoa politicamente exposta (PEP), antecedentes criminais, participação em mais de uma empresa, PEP com processos.

Cada evento traz:

* **Título e descrição**, explicando o que foi identificado.
* **Nível de risco**, definido pela sua empresa.

## Eventos dependem dos dados consultados

Cada evento é calculado a partir de um ou mais dados do Bureau. Um evento só pode ser disparado se o dado de que ele depende estiver na consulta. Por isso, **o pacote escolhido define quais eventos são possíveis**.

> [!TIP]
>
> Alguns dados, como certidões, só são processados em consultas assíncronas. Eventos que dependem deles só aparecem nesse modo.

## Exemplo de retorno

```json theme={"theme":"catppuccin-latte"}
{
  "events": [
    {
      "title": "Multi empresário",
      "eventCode": "MULTI_EMPRESARIO",
      "risk": "high",
      "description": "Está presente no quadro societário de mais de uma empresa"
    },
    {
      "title": "Brasileiro",
      "eventCode": "BRASILEIRO",
      "risk": null,
      "description": "Possui nacionalidade brasileira"
    }
  ],
  "riskProfile": "high"
}
```

**events\[].title** `string`

Título do evento, igual ao cadastrado em Regras de risco.

**events\[].eventCode** `string`

Código fixo do evento, em maiúsculas. Use este campo, e não o título, nas regras da sua integração.

**events\[].risk** `string | null`

Nível configurado para o evento: `low`, `medium`, `high`, `critical`, ou `null` quando o evento está sem definição de risco.

**events\[].description** `string`

Descrição do evento.

**riskProfile** `string`

Risco geral da consulta. Veja [O que é o Perfil de Risco](#o-que-e-o-perfil-de-risco).

## Como configurar o risco

O nível de cada evento é definido pela sua empresa na Plataforma, em **Bureau → Configuração → Pacote desejado → Regras de risco**.

### Níveis disponíveis

| Nível | Valor na API | Significado |
| - | - | - |
| Sem definição de risco | `null` | O evento aparece no resultado, mas não entra no cálculo do risco geral |
| Baixo | `low` | Risco tolerável, dentro dos parâmetros aceitáveis |
| Médio | `medium` | Risco relevante, que foge do padrão esperado |
| Alto | `high` | Risco significativo, com indícios que geram preocupação |
| Crítico | `critical` | Risco severo, com fortes indícios de irregularidade |

### Passo a passo

**1. Acesse as regras de risco**

Na Plataforma, vá em **Bureau → Configuração → Pacote desejado → Regras de risco**.

**2. Encontre o evento**

Use a busca por nome ou descrição, ou filtre por nível de risco. Cada evento já vem com a descrição do que significa.

**3. Defina o nível**

Selecione o nível de risco do evento. Para aplicar o mesmo nível a vários eventos, marque os checkboxes e aplique em lote.

**4. Salve**

Clique em **Salvar configuração**.

> [!WARNING]
>
> A mudança não é retroativa. Consultas em andamento no momento do salvamento usam a configuração anterior; as novas regras valem para as próximas consultas.

### Histórico de alterações

Toda alteração fica registrada na aba **Histórico de alterações**, com data e hora, nível anterior, novo nível e responsável. Use essa trilha para auditoria e compliance.

## O que é o Perfil de Risco

O **risk profile** (`riskProfile`), perfil de risco, é o risco geral da consulta. Ele resume, em um único nível, todos os eventos disparados para aquele CPF ou CNPJ.

### Como é calculado

O risk profile é o **maior nível entre os eventos disparados**, na ordem:

`critical` > `high` > `medium` > `low`

* Não há soma nem agravamento: três eventos `high` resultam em `high`.
* Eventos sem definição de risco (`risk: null`) aparecem na lista, mas **não entram no cálculo**.
* Se nenhum evento disparado tiver nível definido, o risk profile não é calculado.

### Exemplo

| Eventos disparados | Risk profile |
| - | - |
| `low`, `medium`, `high` | `high` |
| `medium`, `critical` | `critical` |
| `low`, `null` | `low` |
| Apenas `null` | Não calculado |

### Onde aparece

* **API:** no campo `riskProfile` do resultado da consulta.
* **Plataforma:** no card de risco do detalhe da transação, identificado como o evento mais alto disparado.

> [!NOTE]
>
> O risk profile é calculado para consultas feitas com pacote. Em consultas com dados avulsos, os eventos nao podem ser disparados.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.