Pular para o conteúdo principal
GET
curl

Visão geral

Retorna um job de monitoramento contínuo de AML iniciado em Ativar ou desativar o monitoramento AML para usuários ou Ativar ou desativar o monitoramento AML para empresas: o status, os contadores por resultado e uma entrada em results para cada usuário ou empresa processado. Seleções com mais de 20 perfis são executadas em segundo plano, e a chamada para ativar ou desativar retorna 202 com um job PENDING. Consulte este endpoint a cada poucos segundos até que status seja COMPLETED ou FAILED. results é preenchido à medida que os perfis são processados, na ordem de processamento, e fica completo quando o job está COMPLETED. Os resultados por registro são gravados para jobs iniciados pela API; um job iniciado pelo Business Console informa apenas os contadores.

Status do job

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

Permissões

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

Conteúdos 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

job_id
string<uuid>
obrigatório

O job_id retornado pelo endpoint de alternância.

Resposta

A tarefa.

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

true quando o job ativa o monitoramento, false quando o desativa.

target_type
enum<string>

Qual família de perfis a tarefa ativa ou desativa.

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

Perfis que o job processa.

processed
integer

Perfis processados até agora.

outcomes
object

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

results
object[]

Uma entrada por perfil processado, na ordem de processamento. Cresce enquanto o job é executado; fica completa quando o status é COMPLETED. Registrado para jobs iniciados pela API; um job iniciado pelo Business Console informa apenas contadores.

error
string | null

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

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