Pular para o conteúdo principal
PATCH
curl

O que este endpoint faz

A Análise AML retorna uma lista de ocorrências (hits): possíveis correspondências com listas de sanções, bancos de dados de PEP, listas de monitoramento e mídia adversa. Cada ocorrência tem um review_status (sua classificação), que começa como Unreviewed ou False Positive conforme a pontuação de correspondência. Este endpoint permite que sua equipe (ou sua automação) registre uma decisão sobre cada ocorrência, sem alterar a decisão geral da sessão. Encontre as ocorrências e seus IDs na decisão da sessão: no array hits da verificação AML, o id de cada ocorrência é o hit_id que você envia aqui. O id de uma ocorrência é hit_ seguido de 24 caracteres hexadecimais e permanece o mesmo quando o titular é analisado novamente. Um ID de ocorrência retornado no formato anterior continua sendo aceito; a resposta sempre identifica a ocorrência pelo seu id atual.

Status de revisão

As decisões dos revisores são preservadas nas novas análises do monitoramento contínuo: uma ocorrência que você marca como False Positive mantém esse status quando o provedor analisa a entidade novamente.

Atualizar uma única ocorrência

PATCH /v3/session/{sessionId}/update-aml-hit-status/
Para uma sessão com várias verificações AML (fluxos de verificação (workflows) em grafo), adicione ?node_id=feature_aml_1 à URL ou inclua "node_id" no corpo para direcionar para uma verificação específica.

Atualizar várias ocorrências de uma vez

PATCH /v3/session/{sessionId}/bulk-update-aml-hit-status/ Envie hit_updates, uma lista de pares { hit_id, review_status }. A operação é tudo ou nada: se algum hit_id não for encontrado, a requisição retorna 404 e nenhuma ocorrência é alterada.
Uma chamada em lote bem-sucedida dispara um único webhook data.updated e registra uma única entrada de atividade com todas as alterações.

O que acontece após uma atualização

  • Webhook: um evento data.updated é disparado na sessão.
  • Registro de auditoria: a alteração é registrada na trilha de revisão da sessão com o autor (chave de API ou usuário), visível na linha do tempo de atividades do painel.
  • O status geral da etapa AML não é alterado: mudar a classificação de uma ocorrência não altera, por si só, o status da etapa AML nem a decisão da sessão. Para alterar o status da etapa AML (Approved / Declined / In Review), use update-feature-status. Para alterar a decisão da sessão, use update-status.

Suporte a KYC e KYB

Funciona tanto para sessões de Verificação de Usuário (KYC) quanto de Verificação de Empresas (KYB): a Didit resolve o sessionId em ambas. No KYB, a verificação AML é executada sobre a empresa e suas pessoas-chave; cada verificação AML expõe suas próprias resultados.

Permissão

Requer a permissão write:sessions, com uma chave de API de cliente (x-api-key) ou um cabeçalho de autorização de usuário.

Erros

Relacionados

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

sessionId
string<uuid>
obrigatório

UUID da sessão de verificação. Aceita IDs de sessão tanto de usuário (KYC) quanto de empresa (KYB): o serviço resolve o ID entre os dois tipos de sessão.

Exemplo:

"11111111-2222-3333-4444-555555555555"

Parâmetros de consulta

node_id
string

ID do nó do grafo do fluxo. Obrigatório apenas quando a sessão tem várias verificações AML (uma por nó); omita-o em sessões com uma única verificação AML.

Exemplo:

"feature_aml_1"

Corpo

application/json
hit_id
string
obrigatório

O id da ocorrência no array hits da verificação AML (hit_...). Um id de ocorrência retornado no formato anterior ainda é aceito.

Exemplo:

"hit_7c1e9a40b2d35f86e0a4c912"

review_status
enum<string>
obrigatório

O novo status de revisão do resultado.

Opções disponíveis:
Unreviewed,
Confirmed Match,
False Positive,
Inconclusive
Exemplo:

"False Positive"

node_id
string

ID opcional do nó do grafo. Use-o (aqui ou como parâmetro de consulta) quando a sessão tiver várias verificações AML.

Exemplo:

"feature_aml_1"

Resposta

Status de revisão da ocorrência atualizado.

message
string
obrigatório

Sempre Hit status updated successfully.

hit_id
string
obrigatório

O id da ocorrência atualizada, como a decisão da sessão o retorna, inclusive quando a requisição indicou a ocorrência por um id no formato anterior.

review_status
enum<string>
obrigatório

O status de revisão agora armazenado no resultado.

Opções disponíveis:
Unreviewed,
Confirmed Match,
False Positive,
Inconclusive
Última modificação em 1 de novembro de 2026