Saltar para o conteúdo principal
POST
curl

Visão geral

Ativa ou desativa a Monitorização AML contínua para as empresas selecionadas, exatamente como a ação Monitorização AML contínua na Business Console. A Console e este endpoint executam a mesma operação subjacente, pelo que as regras, a faturação e os resultados são idênticos. Envie primeiro estimate_only: true para ver quantas empresas estão selecionadas, quantas precisam de uma nova triagem AML, o custo único da triagem e o custo anual da monitorização. Uma simulação não grava nada. A estimativa usa os mesmos nomes de campos do endpoint de utilizadores, pelo que users_total é o número de empresas selecionadas.

Como é processada uma seleção

  • Uma triagem monitorizada por empresa. Uma empresa que foi verificada várias vezes é monitorizada e faturada uma única vez. Desativar a monitorização desliga-a em todas as triagens dessa empresa.
  • As empresas sem triagem AML são submetidas a triagem primeiro. A Didit cria uma nova verificação AML para elas (visível no separador Verificações da empresa), faturada como uma triagem AML normal, e ativa a monitorização nessa verificação. A triagem usa a designação legal (ou o nome de apresentação) e o país da empresa. Uma empresa sem qualquer nome é indicada como skipped_no_identity_data em vez de ser ignorada sem aviso.
  • As aplicações de sandbox nunca criam triagens (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 saber quanto deve carregar.
  • Renovação anual. Uma empresa recém-monitorizada é faturada pelo preço anual de monitorização na sua próxima data de renovação, a mesma data que a Console mostra na coluna Monitorização contínua. Desativar a monitorização interrompe a renovação, mas não reembolsa um período já faturado.

Seleção e tamanho do lote

Selecione empresas com vendor_data_list, didit_internal_id_list, ou ambos; as duas listas são combinadas com OR. Um pedido aceita no máximo 1000 identificadores no total das duas listas. Os identificadores que não correspondem a nenhuma empresa da sua aplicação são devolvidos em unmatched, exatamente como enviados, e nunca fazem o pedido falhar: uma seleção sem correspondências é concluída como uma tarefa vazia (total: 0) com todos os identificadores listados, seguindo a mesma convenção que os endpoints de eliminação em lote.

Em linha ou em segundo plano

Seleções de 20 empresas ou menos são processadas em linha, e a chamada devolve 200 com a tarefa concluída. Seleções maiores devolvem 202 com uma tarefa PENDING. Consulte Obter tarefa de monitorização AML até que status seja COMPLETED ou FAILED. Em qualquer dos casos, a tarefa inclui uma entrada results por empresa, com o respetivo outcome.

Webhooks

Ativar ou desativar a monitorização não emite nenhum webhook próprio. Quando a monitorização estiver ativa, as reanálises continuam a disparar os eventos habituais status.updated e data.updated, descritos em Monitorização AML contínua.

Permissões

Qualquer chave de API ativa da aplicação pode chamar este endpoint. As chaves de API da Didit têm âmbito por aplicação, não por função: as funções e permissões da Console determinam o que uma pessoa pode fazer na Console e não são avaliadas para o tráfego da Management API.

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.

Corpo

application/json

Selecione empresas com vendor_data_list, didit_internal_id_list ou ambos (as duas listas são combinadas com o operador OR). No máximo 1000 identificadores por pedido no total, nas duas listas.

is_enabled
boolean
obrigatório

true para ativar a monitorização, false para a desativar.

estimate_only
boolean
padrão:false

Quando for true, devolve a estimativa de custos e não realiza gravações: sem triagem, sem faturação e sem tarefa.

vendor_data_list
string[]

Os seus próprios identificadores das empresas a alternar, correspondidos exatamente como foram enviados.

didit_internal_id_list
string<uuid>[]

IDs internos da Didit das empresas a alternar - o didit_internal_id devolvido pelos endpoints de criação, obtenção e listagem.

Resposta

A estimativa (quando estimate_only é true) ou a tarefa concluída para uma seleção processada inline.

Pré-visualização do custo. Devolvida diretamente quando estimate_only é true (nada é gravado).

users_total
integer
obrigatório

Perfis correspondidos pela seleção.

already_enabled
integer
obrigatório

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

with_existing_aml
integer
obrigatório

Perfis cuja triagem AML existente será alterada para monitorizada (sem nova triagem).

needing_screening
integer
obrigatório

Perfis sem qualquer triagem AML que serão submetidos a triagem primeiro (faturada como uma triagem AML normal).

skipped_no_identity_data
integer
obrigatório

Perfis que não podem ser submetidos a triagem porque faltam dados de identidade.

skipped_blocked
integer
obrigatório

Utilizadores bloqueados que serão ignorados (sempre 0 para empresas).

estimated_screening_cost_usd
number
obrigatório

Custo único das novas triagens.

Exemplo:

0.2

estimated_annual_monitoring_cost_usd
number
obrigatório

Custo anual de monitorização dos perfis que passarão a ser monitorizados.

Exemplo:

0.07

balance_sufficient
boolean
obrigatório

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

unmatched
string[]
obrigatório

Identificadores do pedido que não corresponderam a nenhum perfil nesta aplicação, exatamente como foram enviados.

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