Pular para o conteúdo principal
POST
curl

Visão geral

Ativa ou desativa o monitoramento AML contínuo das entidades de usuário selecionadas, exatamente como faz a ação Monitoramento contínuo AML no Business Console. O Console e este endpoint executam a mesma operação subjacente, então as regras, o faturamento e os resultados são idênticos. Envie primeiro estimate_only: true para ver quantos usuários estão selecionados, quantos precisam de uma nova análise AML, o custo único da análise e o custo anual do monitoramento. Uma simulação (dry-run) não grava nada.

Quando usar

  • Onboarding programático: ative o monitoramento de usuários que você importou ou criou pela API sem precisar analisá-los de novo manualmente.
  • Desligamento de usuários: interrompa o monitoramento, e a respectiva renovação anual, de usuários que saíram da sua plataforma.
  • Controle de custos: visualize o impacto exato de uma seleção no custo antes de confirmá-la.

Como uma seleção é processada

  • Uma análise monitorada por usuário. Um usuário que se verificou várias vezes é monitorado e cobrado uma única vez. A desativação desliga o monitoramento em todas as análises desse usuário.
  • Usuários sem Análise AML são analisados primeiro. A Didit cria uma nova verificação AML para eles (visível na aba Verificações do usuário), cobrada como uma Análise AML comum, e ativa o monitoramento nela. Isso exige o nome completo, a data de nascimento e o país do usuário; um usuário sem algum desses dados recebe o status skipped_no_identity_data em vez de ser descartado silenciosamente.
  • Usuários bloqueados são ignorados (skipped_blocked). Aplicações de sandbox nunca criam análises (skipped_sandbox).
  • O saldo é verificado antecipadamente. A ativação é recusada com 403 quando o seu saldo não cobre a estimativa, e a resposta inclui a estimativa para que você saiba quanto recarregar.
  • Renovação anual. Um usuário recém-monitorado é cobrado pelo preço anual do monitoramento na próxima data de renovação, a mesma data que o Console mostra na coluna Monitoramento contínuo. A desativação interrompe a renovação; ela não reembolsa um período já cobrado.

Seleção e tamanho do lote

Selecione usuários com vendor_data_list, didit_internal_id_list ou ambos; as duas listas são combinadas com OR. Uma requisição aceita no máximo 1000 identificadores somando as duas listas. Identificadores que não correspondem a nenhum usuário da sua aplicação são retornados em unmatched, exatamente como foram enviados, e nunca fazem a requisição falhar: uma seleção sem nenhuma correspondência é concluída como um job vazio (total: 0) com todos os identificadores listados, a mesma convenção dos endpoints de exclusão em lote.

Processamento imediato ou em segundo plano

Seleções de 20 usuários ou menos são processadas imediatamente e a chamada retorna 200 com o job concluído. Seleções maiores retornam 202 com um job PENDING; consulte Obter job de monitoramento AML periodicamente até que status seja COMPLETED ou FAILED. Em ambos os casos, o job traz uma entrada em results por usuário, com o respectivo outcome.

Webhooks

Ativar ou desativar o monitoramento não emite nenhum webhook próprio. Com o monitoramento ativo, as novas análises continuam disparando os eventos habituais status.updated e data.updated descritos em Monitoramento AML contínuo.

Permissões

Qualquer chave de API ativa da aplicação pode chamar este endpoint. As chaves de API da Didit têm escopo de aplicação, não de função: as funções e permissões do Console definem o que uma pessoa pode fazer no Console e não são consideradas no tráfego da Management API.

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.

Corpo

application/json

Selecione usuários com vendor_data_list, didit_internal_id_list ou ambos (as duas listas são combinadas com OR). No máximo 1000 identificadores por requisição, somando as duas listas.

is_enabled
boolean
obrigatório

true para ativar o monitoramento, false para desativá-lo.

estimate_only
boolean
padrão:false

Quando verdadeiro, retorna a estimativa de custo e não realiza nenhuma gravação: sem triagem, sem faturamento, sem tarefa.

vendor_data_list
string[]

Seus próprios identificadores dos usuários a alternar, comparados exatamente como enviados.

didit_internal_id_list
string<uuid>[]

IDs internos da Didit dos usuários cujo status será alternado: o didit_internal_id retornado pelos endpoints de criação, consulta e listagem.

Resposta

A estimativa (quando estimate_only é true) ou o job concluído para uma seleção processada na própria requisição.

Prévia de custo. Retornada diretamente quando estimate_only é true (nada é gravado).

users_total
integer
obrigatório

Perfis correspondentes à seleção.

already_enabled
integer
obrigatório

Perfis já monitorados (nada a fazer ao ativar; são estes que a desativação desliga).

with_existing_aml
integer
obrigatório

Perfis cuja análise AML existente passará a ser monitorada (sem nova análise).

needing_screening
integer
obrigatório

Perfis sem nenhuma análise AML, que serão analisados primeiro (cobrado como uma análise AML comum).

skipped_no_identity_data
integer
obrigatório

Perfis que não podem ser analisados porque faltam dados de identidade.

skipped_blocked
integer
obrigatório

Usuários bloqueados que serão ignorados (sempre 0 para empresas).

estimated_screening_cost_usd
number
obrigatório

Custo único das novas análises.

Exemplo:

0.2

estimated_annual_monitoring_cost_usd
number
obrigatório

Custo anual de monitoramento dos perfis que passarão a ser monitorados.

Exemplo:

0.07

balance_sufficient
boolean
obrigatório

Se o saldo da organização cobre a triagem mais o primeiro ano de monitoramento.

unmatched
string[]
obrigatório

Identificadores da requisição que não corresponderam a nenhum perfil nesta aplicação, exatamente como enviados.

Última modificação em 1 de novembro de 2026