Saltar para o conteúdo principal
PATCH
curl

O que faz

A triagem AML devolve uma lista de hits, ou seja, possíveis correspondências com listas de sanções, bases de dados de PEP, listas de vigilância e notícias adversas. Cada hit tem um review_status (o seu estado de decisão), que começa como Unreviewed ou False Positive, consoante a pontuação de correspondência. Este endpoint permite à sua equipa (ou à sua automatização) registar uma decisão sobre cada hit, sem alterar a decisão global da sessão. Encontre os hits e os respetivos IDs na decisão da sessão, no array hits da verificação AML, onde o id de cada hit é o hit_id que envia aqui. O id de um hit tem o formato hit_ seguido de 24 caracteres hexadecimais e mantém-se igual quando o sujeito é submetido a nova triagem. Um id de hit devolvido no formato anterior continua a ser aceite; a resposta indica sempre o id atual do hit.

Estados de revisão

As decisões do revisor são preservadas nas novas verificações da monitorização contínua: um hit que marcar como False Positive mantém esse estado quando o fornecedor voltar a submeter a entidade a triagem.

Atualizar um único hit

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

Atualizar vários hits de uma só 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, o pedido devolve 404 e nenhum hit é alterado.
Uma chamada em massa bem-sucedida dispara um único webhook data.updated e regista uma entrada de atividade que cobre todas as alterações.

O que acontece após uma atualização

  • Webhook: um evento data.updated é disparado na sessão.
  • Registo de auditoria: a alteração fica registada no histórico de revisão da sessão, com o autor (chave de API ou utilizador), visível na cronologia de atividade da consola.
  • O estado global do passo AML não é alterado: alterar o estado de um hit não altera, por si só, o estado do passo AML nem a decisão da sessão. Para alterar o estado do passo AML (Approved / Declined / In Review), use update-feature-status. Para alterar a decisão da sessão, use update-status.

Suporte para KYC e KYB

Funciona tanto para sessões de Verificação de utilizadores (KYC) como de Verificação de empresas (KYB): a Didit resolve o sessionId em ambos os casos. Em KYB, a triagem AML é feita sobre a empresa e as suas pessoas-chave, e cada verificação AML expõe os seus próprios hits.

Permissão

Requer o privilégio write:sessions, com uma chave de API de cliente (x-api-key) ou um cabeçalho de autorização de utilizador.

Erros

Relacionados

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. 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 de utilizador (KYC) e de empresa (KYB) — o serviço resolve o ID em ambos os 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 possui múltiplas verificações AML (uma por nó); omita-o para sessões com apenas uma 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 é aceite.

Exemplo:

"hit_7c1e9a40b2d35f86e0a4c912"

review_status
enum<string>
obrigatório

O novo estado de revisão para o resultado.

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

"False Positive"

node_id
string

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

Exemplo:

"feature_aml_1"

Resposta

Estado de revisão de ocorrências atualizado.

message
string
obrigatório

Sempre Hit status updated successfully.

hit_id
string
obrigatório

O id da ocorrência atualizada, conforme retornado pela decisão da sessão, também quando o pedido indicou a ocorrência por um id no formato anterior.

review_status
enum<string>
obrigatório

O estado de revisão agora armazenado na ocorrência.

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