> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar job de monitoramento AML via API

> Consulte na API da Didit o status, contadores e resultados por registro de um job de monitoramento contínuo AML de usuários ou empresas.



Prompt para consultar um job de monitoramento AML
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`Goal: Read the status and the per-record results of an AML ongoing monitoring job started with POST /v3/users/aml-monitoring/ or POST /v3/businesses/aml-monitoring/. Needed whenever the toggle call returned 202 (more than 20 profiles); also works for jobs that already completed inline.

Endpoint: GET https://verification.didit.me/v3/aml-monitoring/jobs/{job_id}/
Auth header: x-api-key: <DIDIT_API_KEY>

Path param:
\- job_id: the job_id returned by the toggle endpoint.

curl:
curl 'https://verification.didit.me/v3/aml-monitoring/jobs/JOB_ID/' \
-H 'x-api-key: YOUR_API_KEY'

Response 200:
\{
"job_id": "<uuid>",
"status": "PROCESSING",            // PENDING | PROCESSING | COMPLETED | FAILED
"is_enabled": true,
"target_type": "user",             // user | business
"total": 120,
"processed": 40,
"outcomes": {"enabled": 12, "screened_and_enabled": 25, "already_enabled": 3, "disabled": 0, "skipped_no_identity_data": 0, "skipped_blocked": 0, "skipped_sandbox": 0, "failed_provider": 0, "failed_insufficient_balance": 0},
"results": [
\{"didit_internal_id": "<uuid>", "vendor_data": "user-123", "outcome": "enabled"},
...one entry per processed profile, in processing order...
],
"error": null,                     // generic message when status is FAILED
"created_at": "<datetime>",
"completed_at": null
}

Polling: request the job every couple of seconds while status is PENDING or PROCESSING. results grows as profiles are processed and is complete once status is COMPLETED. A FAILED job keeps the results recorded before the failure and carries a short generic message in error; re-send the toggle request for the profiles that have no result yet. Per-record results are recorded for jobs started through the API; a job started from the Business Console reports counters only.

Failure modes:
\- 401 - missing/invalid x-api-key.
\- 404 - no such job for this application (jobs are only visible to the application that created them).

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\</pre>



      
      

Colar em

## Visão geralRetorna um job de monitoramento contínuo de AML iniciado em [Ativar ou desativar o monitoramento AML para usuários](https://docs.didit.me/pt-br/management-api/aml-monitoring/toggle-users.md) ou [Ativar ou desativar o monitoramento AML para empresas](https://docs.didit.me/pt-br/management-api/aml-monitoring/toggle-businesses.md): 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| `status` | Significado |
| - | - |
| `PENDING` | Aceito, ainda não iniciado. |
| `PROCESSING` | Em execução; `processed`, `outcomes` e `results` estão sendo atualizados. |
| `COMPLETED` | Todos os perfis têm um resultado. |
| `FAILED` | O job foi interrompido antes do fim. `error` traz uma mensagem genérica curta, e os resultados gravados antes da falha são mantidos. Reenvie a requisição de ativação ou desativação para os perfis que ainda não têm resultado. |Os valores de `outcome` por registro estão documentados nas páginas de ativação e desativação.## PermissõesQualquer 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- [Ativar ou desativar o monitoramento AML para usuários](https://docs.didit.me/pt-br/management-api/aml-monitoring/toggle-users.md)
- [Ativar ou desativar o monitoramento AML para empresas](https://docs.didit.me/pt-br/management-api/aml-monitoring/toggle-businesses.md)
- [Monitoramento AML contínuo](https://docs.didit.me/pt-br/core-technology/aml-screening/continuous-monitoring-aml-screening.md)


## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/aml-monitoring/jobs/{job_id}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/aml-monitoring/jobs/{job_id}/:
    get:
      tags:
        - AML Ongoing Monitoring
      summary: Obter um job de monitoramento AML contínuo
      description: >-
        Status, contadores de resultado e resultados por registro de um job de
        ativação/desativação do monitoramento iniciado a partir de `POST
        /v3/users/aml-monitoring/` ou `POST /v3/businesses/aml-monitoring/`.
        Consulte a cada poucos segundos enquanto `status` for `PENDING` ou
        `PROCESSING`; `results` está completo quando ele for `COMPLETED`.
      operationId: get_aml_monitoring_job
      parameters:
        - name: job_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: O `job_id` retornado pelo endpoint de alternância.
      responses:
        '200':
          description: A tarefa.
          content:
            application/json:
              schema:
                type: object
                properties:
                  job_id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - PENDING
                      - PROCESSING
                      - COMPLETED
                      - FAILED
                  is_enabled:
                    type: boolean
                    description: >-
                      true quando o job ativa o monitoramento, false quando o
                      desativa.
                  target_type:
                    type: string
                    enum:
                      - user
                      - business
                    description: Qual família de perfis a tarefa ativa ou desativa.
                  total:
                    type: integer
                    description: Perfis que o job processa.
                  processed:
                    type: integer
                    description: Perfis processados até agora.
                  outcomes:
                    type: object
                    description: >-
                      Contadores de resultado por registro. Cada perfil
                      selecionado corresponde a exatamente um contador; nada é
                      ignorado silenciosamente.
                    properties:
                      enabled:
                        type: integer
                        description: Monitoramento ativado em uma análise AML existente.
                      screened_and_enabled:
                        type: integer
                        description: >-
                          Uma nova análise AML foi criada (cobrada) e o
                          monitoramento foi ativado nela.
                      already_enabled:
                        type: integer
                        description: >-
                          O monitoramento já estava ativo; nada foi alterado e
                          nada foi cobrado.
                      disabled:
                        type: integer
                        description: >-
                          Monitoramento desativado em todas as análises AML do
                          perfil.
                      skipped_no_identity_data:
                        type: integer
                        description: >-
                          Ignorado: o perfil não tem o nome completo, a data de
                          nascimento e o país (usuários) ou um nome (empresas)
                          necessários para a análise.
                      skipped_blocked:
                        type: integer
                        description: 'Ignorado: o usuário está bloqueado.'
                      skipped_sandbox:
                        type: integer
                        description: >-
                          Ignorado: aplicação de sandbox, nenhuma análise é
                          criada.
                      failed_provider:
                        type: integer
                        description: >-
                          Não foi possível concluir a análise; tente novamente
                          mais tarde.
                      failed_insufficient_balance:
                        type: integer
                        description: O saldo acabou enquanto a tarefa estava em execução.
                  results:
                    type: array
                    description: >-
                      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.
                    items:
                      type: object
                      properties:
                        didit_internal_id:
                          type: string
                          format: uuid
                          description: ID interno da Didit para o perfil.
                        vendor_data:
                          type: string
                          nullable: true
                          description: Seu próprio identificador para o perfil.
                        outcome:
                          type: string
                          enum:
                            - enabled
                            - screened_and_enabled
                            - already_enabled
                            - disabled
                            - skipped_no_identity_data
                            - skipped_blocked
                            - skipped_sandbox
                            - failed_provider
                            - failed_insufficient_balance
                  error:
                    type: string
                    nullable: true
                    description: >-
                      Mensagem genérica de falha quando o status é FAILED; a
                      causa detalhada é mantida no lado da plataforma.
                  created_at:
                    type: string
                    format: date-time
                  completed_at:
                    type: string
                    format: date-time
                    nullable: true
        '401':
          description: Chave de API ausente ou inválida.
        '404':
          description: Job não encontrado para esta aplicação.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl 'https://verification.didit.me/v3/aml-monitoring/jobs/JOB_ID/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.aml_monitoring.retrieve_job(
                "11111111-2222-3333-4444-555555555555",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.amlMonitoring.retrieveJob("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.AMLMonitoring.RetrieveJob(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.amlMonitoring().retrieveJob("11111111-2222-3333-4444-555555555555");

            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->amlMonitoring->retrieveJob('11111111-2222-3333-4444-555555555555');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.aml_monitoring.retrieve_job("11111111-2222-3333-4444-555555555555")

            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.AmlMonitoring.RetrieveJobAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.