Saltar para o conteúdo principal
GET
curl

Descrição geral

Devolve uma tarefa de monitorização AML contínua iniciada a partir de Ativar/desativar monitorização AML para utilizadores ou Ativar/desativar monitorização AML para empresas: o respetivo estado, os contadores por resultado e uma entrada em results por cada utilizador ou empresa processados. As seleções com mais de 20 perfis são executadas em segundo plano, e o pedido de ativação/desativação devolve 202 com uma tarefa PENDING. Consulte este endpoint a cada dois segundos até status ser COMPLETED ou FAILED. results é preenchido à medida que os perfis são processados, pela ordem de processamento, e fica completo quando a tarefa estiver COMPLETED. Os resultados por registo são guardados para tarefas iniciadas através da API; uma tarefa iniciada na Business Console devolve apenas os contadores.

Estado da tarefa

Os valores de outcome por registo estão documentados nas páginas de ativação/desativação.

Permissões

Qualquer chave de API ativa da aplicação pode chamar este endpoint. Uma tarefa só é visível para a aplicação que a criou; qualquer outro job_id devolve 404.

Conteúdo relacionado

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

job_id
string<uuid>
obrigatório

O job_id devolvido pelo endpoint de ativação/desativação.

Resposta

A tarefa.

job_id
string<uuid>
status
enum<string>
Opções disponíveis:
PENDING,
PROCESSING,
COMPLETED,
FAILED
is_enabled
boolean

true quando o trabalho ativa a monitorização, false quando a desativa.

target_type
enum<string>

Qual a família de perfis que a tarefa ativa/desativa.

Opções disponíveis:
user,
business
total
integer

Perfis que a tarefa processa.

processed
integer

Perfis processados até ao momento.

outcomes
object

Contadores de resultados por registo. Cada perfil selecionado corresponde exatamente a um contador; nada é ignorado silenciosamente.

results
object[]

Uma entrada por perfil processado, pela ordem de processamento. Aumenta enquanto a tarefa é executada; completa assim que o estado for COMPLETED. Registada para tarefas iniciadas através da API; uma tarefa iniciada a partir da Business Console reporta apenas contadores.

error
string | null

Mensagem genérica de falha quando o estado é FAILED; a causa detalhada é mantida do lado da plataforma.

created_at
string<date-time>
completed_at
string<date-time> | null
Última modificação em 7 de novembro de 2026