> ## 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.

# Histórico de Triagem AML: API de Listagem

> Didit: lista cada nova triagem AML contínua de uma sessão, incluindo execuções sem alterações, com resultado, pontuação e atualização das listas.

Prompt da API para listar o histórico de triagem AML
Copiar o prompt para a área de transferência

<pre>
  \`List the ongoing AML monitoring history of one Didit verification session through the API.

  Endpoint:
  GET [https://verification.didit.me/v3/session/\{session\_id}/aml-screening-history/](https://verification.didit.me/v3/session/\{session_id}/aml-screening-history/)

  Authentication:
  Send my Didit API key in the x-api-key header. A scoped key needs decisions: read.

  Goal:

  * Prove that ongoing AML monitoring ran for a subject, including the re-screens that found nothing new, for example to answer an auditor.

  Query parameters:

  * node\_id (optional): the workflow node ID of the AML check when the session ran several AML steps. Without it, the most recent AML check is used.
  * limit (default 50) and offset: pagination.

  Behavior:

  * Works for user (KYC) and business (KYB) session IDs.
  * Returns { count, next, previous, results }, newest first by completed\_at. count is exact up to 100 and capped at 100 above that, so follow next until it is null.
  * Only ongoing-monitoring re-screens are listed. The first screening is part of the session decision, so a session without ongoing monitoring returns an empty list.
  * History starts when the feature was introduced; earlier screenings are not reconstructed.

  Example call:
  curl -X GET "[https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/aml-screening-history/](https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/aml-screening-history/)" \
  -H "x-api-key: YOUR\_API\_KEY"

  What to read from the response:

  * results\[].completed\_at: when the re-screen finished. started\_at: when its batch started.
  * results\[].outcome: NO\_CHANGE (completed, result unchanged), CHANGED (score, status or hits moved) or FAILED (no usable answer for this subject, nothing changed).
  * results\[].status, score and total\_hits: the state the re-screen left the check in.
  * results\[].dataset\_freshness: how current the screening datasets were (sources.sanctions, pep, warnings, adverse\_media with last\_updated\_at and oldest\_updated\_at), or null when no dates were available. Dates are never estimated.
  * results\[].provider and dataset\_freshness.provider: an identifier of the data source. Treat it as an opaque string.

  Failure modes:

  * 400: limit or offset above 1,000,000.
  * 401: the API key has expired.
  * 403: missing key (a wrong, revoked or expired key gets 401), a key of another application, a scoped key without decisions: read, or a request from outside the key's IP allowlist.
  * 404: the session does not exist, was deleted, or is outside a scoped key's limits, or it has no AML check (for that node\_id).

  Side effects: none. This is a pure read.

  For the full integration shape, see /integration/integration-prompt.\`
</pre>

Colar em

Os alertas, as entradas de atividade e os webhooks só são disparados quando um resultado de triagem muda, por isso este histórico é o registo de que um sujeito sem alertas continuava a ser alvo de triagem. [Monitorização AML contínua](https://docs.didit.me/pt/core-technology/aml-screening/continuous-monitoring-aml-screening.md) explica como são executadas as novas triagens e o que significa cada campo. Para entregar o mesmo histórico a um auditor sob a forma de ficheiro, use [Exportar histórico de triagem AML](https://docs.didit.me/pt/management-api/sessions/export-aml-screening-history.md).


## OpenAPI

````yaml pt/openapi-25.json GET /v3/session/{sessionId}/aml-screening-history/
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/session/{sessionId}/aml-screening-history/:
    get:
      tags:
        - Sessions
      summary: Listar histórico de triagem AML
      description: >-
        Listar todas as retriagens de monitorização contínua concluídas da
        verificação AML de uma sessão, da mais recente para a mais antiga por
        `completed_at`, incluindo as execuções em que nada mudou: os alertas,
        entradas de atividade e webhooks só são acionados quando um resultado é
        alterado, pelo que este histórico serve como prova de que um sujeito sem
        ocorrências continuava a ser triado. Funciona para IDs de sessão de KYC
        e KYB; passe `node_id` quando a sessão tiver executado mais do que um
        passo de AML. Apenas as retriagens de monitorização contínua são
        listadas (a primeira triagem faz parte da decisão da sessão) e as
        execuções anteriores à existência deste histórico não são reconstruídas,
        pelo que uma sessão sem monitorização contínua devolve uma lista vazia.
        O `count` é exato até 100 e limitado a 100 acima desse valor, pelo que
        deve seguir `next` até ser `null`. Passe `month` para consultar um mês
        civil de cada vez. Uma chave de API com âmbito restrito necessita de
        `decisions: read`; consulte [Monitorização AML
        contínua](https://docs.didit.me/pt/core-technology/aml-screening/continuous-monitoring-aml-screening).
      operationId: get_v3_session_aml_screening_history
      parameters:
        - name: sessionId
          in: path
          required: true
          description: >-
            UUID da sessão de verificação (o `session_id` retornado por `POST
            /v3/session/`). Aceita IDs de sessão de Verificação de utilizadores
            (KYC) e de Verificação de empresas (KYB): o servidor resolve o ID em
            ambos os tipos de sessão. Deve ser um UUID bem formatado; um valor
            mal formatado não corresponde à rota e retorna um `404` em HTML.
          schema:
            type: string
            format: uuid
            example: 11111111-2222-3333-4444-555555555555
        - name: node_id
          in: query
          required: false
          description: >-
            ID do nó do grafo do fluxo da verificação AML. Necessário apenas
            quando a sessão executou mais de um passo AML; sem ele, é utilizada
            a verificação AML mais recente. Um nó desconhecido devolve `404`.
          schema:
            type: string
            example: feature_aml_1
        - name: month
          in: query
          required: false
          description: >-
            Um mês de calendário UTC no formato `YYYY-MM`. Apenas são devolvidas
            as triagens concluídas nesse mês; sem este parâmetro, são devolvidos
            todos os meses. Um mês mal formatado devolve `400`.
          schema:
            type: string
            pattern: ^\d{4}-(0[1-9]|1[0-2])$
            example: 2026-09
        - name: limit
          in: query
          required: false
          description: >-
            Número máximo de execuções de triagem por página. O valor
            predefinido é 50. Um valor inferior a 1 ou um valor não numérico
            reverte para 50; um valor acima de 1,000,000 devolve `400`.
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
            example: 50
        - name: offset
          in: query
          required: false
          description: >-
            Número de resultados a ignorar antes do primeiro devolvido. O valor
            predefinido é 0; um valor negativo ou não numérico reverte para 0,
            um valor acima de 1,000,000 devolve `400`. Prefira seguir os URLs
            `next` e `previous`.
          schema:
            type: integer
            default: 0
            minimum: 0
            maximum: 1000000
            example: 0
        - name: ordering
          in: query
          required: false
          description: >-
            Substituição opcional da ordenação. A ordem predefinida é
            `-completed_at`. Indique o nome de um campo de resultado (por
            exemplo `completed_at`, `started_at`, `outcome` ou `score`) para
            ordenar ascendentemente, use o prefixo `-` para ordenar
            descendentemente e separe múltiplos campos com vírgulas. Campos
            desconhecidos são ignorados.
          schema:
            type: string
            example: completed_at
      responses:
        '200':
          description: Uma página de execuções de triagem, as mais recentes primeiro.
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - next
                  - previous
                  - results
                properties:
                  count:
                    type: integer
                    maximum: 100
                    description: >-
                      Número de execuções, exato até 100 e limitado a 100 acima
                      desse valor.
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: URL da página seguinte, ou `null` na última página.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: URL da página anterior, ou `null` na primeira página.
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/AMLScreeningRun'
              examples:
                Monitored subject:
                  value:
                    count: 2
                    next: null
                    previous: null
                    results:
                      - uuid: dddddddd-1111-2222-3333-444444444444
                        run_id: aaaaaaaa-1111-2222-3333-444444444444
                        completed_at: '2026-09-14T04:12:33.481207Z'
                        started_at: '2026-09-14T04:00:01.002311Z'
                        outcome: NO_CHANGE
                        trigger: ONGOING_MONITORING
                        provider: aml_data_source
                        status: Approved
                        score: 0
                        total_hits: 0
                        new_hits: 0
                        entities_screened: 1
                        dataset_freshness:
                          captured_at: '2026-09-14T03:58:02.114820+00:00'
                          provider: aml_data_source
                          catalog_version: '2026-09-13'
                          sources:
                            sanctions:
                              last_updated_at: '2026-09-13T21:10:00+00:00'
                              oldest_updated_at: '2026-09-11T06:00:00+00:00'
                              dataset_count: 120
                              dated_dataset_count: 120
                            pep:
                              last_updated_at: '2026-09-13T08:00:00+00:00'
                              oldest_updated_at: null
                              dataset_count: 45
                              dated_dataset_count: 44
                            warnings:
                              last_updated_at: '2026-09-12T18:45:00+00:00'
                              oldest_updated_at: '2026-09-01T00:00:00+00:00'
                              dataset_count: 30
                              dated_dataset_count: 30
                      - uuid: eeeeeeee-1111-2222-3333-444444444444
                        run_id: bbbbbbbb-1111-2222-3333-444444444444
                        completed_at: '2026-09-13T04:11:58.020914Z'
                        started_at: '2026-09-13T04:00:00.871022Z'
                        outcome: FAILED
                        trigger: ONGOING_MONITORING
                        provider: aml_data_source
                        status: Approved
                        score: 0
                        total_hits: 0
                        new_hits: null
                        entities_screened: 0
                        dataset_freshness: null
        '400':
          description: >-
            `limit` ou `offset` é superior a 1,000,000 (um array JSON com uma
            mensagem), ou `month` não é um mês civil no formato `YYYY-MM` (um
            objeto cuja chave é `month`).
          content:
            application/json:
              examples:
                Limit too large:
                  summary: limit=2000000
                  value:
                    - limit must not exceed 1000000.
                Offset too large:
                  summary: offset=2000000
                  value:
                    - offset must not exceed 1000000.
                Malformed month:
                  summary: month=2026-13
                  value:
                    month:
                      - Not a calendar month. Use YYYY-MM.
              schema:
                oneOf:
                  - type: array
                    items:
                      type: string
                  - type: object
                    properties:
                      month:
                        type: array
                        items:
                          type: string
        '401':
          description: >-
            A chave de API com âmbito expirou. Este é o único caso que devolve
            `401`: uma chave em falta, inválida ou revogada devolve `403`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Expired key:
                  summary: A data de validade da chave já passou
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Falha de autenticação ou autorização. Uma chave em falta devolve
            `403`, assim como uma chave de outra aplicação, uma chave com âmbito
            restrito sem a permissão que este endpoint requer e um pedido
            proveniente de fora da lista de IPs permitidos da chave; uma chave
            incorreta, revogada ou expirada devolve `401`. Distinga-as através
            de `detail`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Missing or invalid credentials:
                  summary: Sem cabeçalho x-api-key ou a chave falhou a validação
                  value:
                    detail: >-
                      Authentication credentials were not provided or are
                      invalid.
                Other application:
                  summary: >-
                    Uma chave válida que pertence a uma aplicação diferente da
                    sessão
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without decisions read:
                  summary: 'Chave com âmbito não tem decisions: read'
                  value:
                    detail: This API key has no read access to decisions.
                IP not allowed:
                  summary: >-
                    Pedido proveniente de fora da lista de permissões de IP da
                    chave
                  value:
                    detail: This API key can't be used from this IP address.
        '404':
          description: >-
            A sessão não existe, foi eliminada ou está fora dos limites de uma
            chave com âmbito restrito, ou não tem uma verificação AML (para o
            `node_id` indicado). A pesquisa da sessão é executada antes da
            verificação de credenciais, pelo que um `sessionId` desconhecido
            devolve `404` mesmo sem uma chave válida.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Unknown session:
                  summary: Não existe nenhuma sessão com este ID ou foi eliminada
                  value:
                    detail: Not found.
                Outside key limits:
                  summary: >-
                    A sessão está fora dos limites de uma chave com âmbito
                    restrito (também devolvido para uma sessão eliminada há
                    momentos)
                  value:
                    detail: Session not found.
                No AML check:
                  summary: A sessão nunca executou um passo AML
                  value:
                    detail: The session does not have an AML check.
                No AML check for node:
                  summary: node_id não corresponde a uma verificação AML da sessão
                  value:
                    detail: >-
                      The session does not have an AML check for node
                      'feature_aml_2'.
        '429':
          description: >-
            Limite de pedidos excedido: 600 pedidos GET por minuto por chave de
            API. Aguarde `Retry-After` segundos antes de tentar novamente; os
            cabeçalhos `X-RateLimit-*` mostram o orçamento disponível.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Rate limited:
                  summary: Orçamento esgotado para o minuto atual
                  value:
                    detail: >-
                      GET request rate limit exceeded. You can make up to 600
                      requests per minute.
          headers:
            Retry-After:
              description: Segundos a aguardar antes de tentar novamente.
              schema:
                type: integer
                minimum: 1
                example: 30
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/aml-screening-history/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            for item in client.sessions.list_aml_screening_history(
                "11111111-2222-3333-4444-555555555555",
            ):
                print(item)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            for await (const item of
            didit.sessions.listAmlScreeningHistory("11111111-2222-3333-4444-555555555555"))
            {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.ListAMLScreeningHistoryAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsListAMLScreeningHistoryParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            for (var item :
            client.sessions().listAmlScreeningHistory("11111111-2222-3333-4444-555555555555"))
            {
                System.out.println(item);
            }
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            foreach
            ($didit->sessions->listAmlScreeningHistory('11111111-2222-3333-4444-555555555555')
            as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            didit.sessions.list_aml_screening_history("11111111-2222-3333-4444-555555555555").auto_paging_each
            do |item|
              puts item.to_h
            end
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            await foreach (var item in await
            client.Sessions.ListAmlScreeningHistoryAsync("11111111-2222-3333-4444-555555555555"))

            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    AMLScreeningRun:
      type: object
      description: >-
        Uma nova triagem concluída de monitorização contínua de uma verificação
        AML.
      required:
        - uuid
        - run_id
        - completed_at
        - started_at
        - outcome
        - trigger
        - provider
        - status
        - score
        - total_hits
        - new_hits
        - entities_screened
        - dataset_freshness
      properties:
        uuid:
          type: string
          format: uuid
          description: Identificador desta execução de triagem.
        run_id:
          type: string
          format: uuid
          description: >-
            A execução de monitorização à qual esta triagem pertence. Todas as
            verificações triadas na mesma execução partilham-na.
        completed_at:
          type: string
          format: date-time
          description: >-
            Quando a nova triagem deste sujeito terminou. Os resultados são
            ordenados por este campo, do mais recente para o mais antigo.
        started_at:
          type: string
          format: date-time
          description: >-
            Quando o lote de monitorização a que esta nova triagem pertence foi
            iniciado.
        outcome:
          type: string
          enum:
            - NO_CHANGE
            - CHANGED
            - FAILED
          description: >-
            `NO_CHANGE`: concluído e o resultado não se alterou. `CHANGED`:
            concluído e a pontuação, estado, contagem de ocorrências ou
            ocorrências foram alterados. `FAILED`: sem resposta utilizável para
            este sujeito, pelo que a verificação foi mantida como estava.
        trigger:
          type: string
          enum:
            - ONGOING_MONITORING
          description: O que iniciou a triagem. Atualmente, é sempre `ONGOING_MONITORING`.
        provider:
          type: string
          description: >-
            Identificador opaco da fonte de dados AML que respondeu. Trate-o
            como uma string opaca; não crie ramificações lógicas com base nele.
          example: aml_data_source
        status:
          type: string
          nullable: true
          enum:
            - Not Finished
            - Approved
            - Declined
            - In Review
            - Resub Requested
            - null
          description: Estado da verificação AML após esta execução.
        score:
          type: number
          format: float
          nullable: true
          minimum: 0
          maximum: 100
          description: Pontuação AML atribuída à verificação nesta execução.
        total_hits:
          type: integer
          nullable: true
          description: Número de resultados com que esta execução deixou a verificação.
        new_hits:
          type: integer
          nullable: true
          description: >-
            Número de resultados encontrados nesta execução que a verificação
            não tinha antes. `0` quando nada de novo foi encontrado; `null`
            quando a execução falhou ou foi registada antes da existência desta
            contagem.
        entities_screened:
          type: integer
          minimum: 0
          maximum: 1
          description: >-
            Número de entidades triadas nesta execução para a verificação: `1`
            quando o sujeito foi triado, `0` quando a execução falhou.
        dataset_freshness:
          allOf:
            - $ref: '#/components/schemas/AMLDatasetFreshness'
          nullable: true
          description: >-
            Atualidade do conjunto de dados subjacente a esta execução, ou
            `null` quando não havia datas disponíveis.
    AMLDatasetFreshness:
      type: object
      description: >-
        O quão atualizados estavam os conjuntos de dados de AML quando uma
        triagem foi executada. As datas nunca são estimadas.
      required:
        - captured_at
        - provider
        - catalog_version
        - sources
      properties:
        captured_at:
          type: string
          format: date-time
          description: >-
            Quando a Didit leu o catálogo de conjuntos de dados de onde provém
            esta informação sobre a atualidade dos dados.
        provider:
          type: string
          description: >-
            Identificador opaco da fonte de dados AML. Trate-o como uma string
            opaca; não crie ramificações lógicas com base nele.
          example: aml_data_source
        catalog_version:
          type: string
          nullable: true
          description: >-
            Identificador da versão do catálogo do conjunto de dados, quando a
            fonte comunica um.
        sources:
          type: object
          description: >-
            Atualidade por família de conjuntos de dados. Uma família cujos
            conjuntos de dados não reportaram data de atualização fica ausente
            em vez de preenchida com `null`.
          properties:
            sanctions:
              $ref: '#/components/schemas/AMLDatasetSourceFreshness'
            pep:
              $ref: '#/components/schemas/AMLDatasetSourceFreshness'
            warnings:
              $ref: '#/components/schemas/AMLDatasetSourceFreshness'
            adverse_media:
              $ref: '#/components/schemas/AMLDatasetSourceFreshness'
    AMLDatasetSourceFreshness:
      type: object
      description: Atualidade de uma família de conjuntos de dados AML.
      required:
        - last_updated_at
        - oldest_updated_at
        - dataset_count
        - dated_dataset_count
      properties:
        last_updated_at:
          type: string
          format: date-time
          description: Atualização mais recente de qualquer conjunto de dados da família.
        oldest_updated_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Limite de desatualização: todos os conjuntos de dados na família são
            pelo menos tão atuais quanto este valor. `null` quando pelo menos um
            conjunto de dados na família não comunicou uma data de atualização,
            dado que o limite é desconhecido.
        dataset_count:
          type: integer
          description: Número de conjuntos de dados na família.
        dated_dataset_count:
          type: integer
          description: >-
            Número desses conjuntos de dados que comunicaram uma data de
            atualização.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        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.

````

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