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

# Historial de cribratge AML: API de llistat

> Llista cada nou cribratge AML d'una sessió amb Didit, també els sense canvis, amb resultat, puntuació i frescor de les llistes.

Prompt de l'API per llistar l'historial de cribratge AML
Copia el prompt al porta-retalls

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

Enganxa a

Les alertes, les entrades d'activitat i els webhooks només s'activen quan un resultat de cribratge canvia, de manera que aquest historial és el registre que demostra que un subjecte sense incidències continuava sota cribratge. [Monitoratge AML continu](https://docs.didit.me/ca/core-technology/aml-screening/continuous-monitoring-aml-screening.md) explica com es duen a terme els recribratges i què significa cada camp. Per lliurar el mateix historial a un auditor en forma de fitxer, fes servir [Exportar l'historial de cribratge AML](https://docs.didit.me/ca/management-api/sessions/export-aml-screening-history.md).


## OpenAPI

````yaml ca/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 verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/session/{sessionId}/aml-screening-history/:
    get:
      tags:
        - Sessions
      summary: Llistar l'historial de cribratge AML
      description: >-
        Llista cada nou cribratge de monitoratge continu completat de la
        comprovació AML d'una sessió, els més recents primer per `completed_at`,
        incloses les execucions en què res no va canviar: les alertes, les
        entrades d'activitat i els webhooks només es disparen quan un resultat
        canvia, de manera que aquest historial és la prova que un subjecte net
        continuava sent sotmès a cribratge. Funciona per a identificadors de
        sessió de KYC i KYB; passa `node_id` quan la sessió hagi executat més
        d'un pas d'AML. Només es llisten els nous cribratges de monitoratge
        continu (el primer cribratge forma part de la decisió de la sessió) i no
        es reconstrueixen les execucions anteriors a l'existència d'aquest
        historial, per la qual cosa una sessió sense monitoratge continu retorna
        una llista buida. `count` és exacte fins a 100 i es limita a 100 per
        sobre d'aquest valor, de manera que segueix `next` fins que sigui
        `null`. Passa `month` per llegir un mes natural a la vegada. Una clau
        d'API amb àmbit necessita `decisions: read`; consulta [Monitoratge AML
        continu](https://docs.didit.me/ca/core-technology/aml-screening/continuous-monitoring-aml-screening).
      operationId: get_v3_session_aml_screening_history
      parameters:
        - name: sessionId
          in: path
          required: true
          description: >-
            UUID de la sessió de verificació (el `session_id` retornat per `POST
            /v3/session/`). Accepta tant IDs de sessió de Verificació d'usuaris
            (KYC) com de Verificació d'empreses (KYB): el servidor resol l'ID
            entre tots dos tipus de sessió. Ha de ser un UUID ben format; un
            valor mal format no coincideix amb la ruta i retorna un `404` en
            HTML.
          schema:
            type: string
            format: uuid
            example: 11111111-2222-3333-4444-555555555555
        - name: node_id
          in: query
          required: false
          description: >-
            ID del node del graf del flux de treball del cribratge AML. Només
            cal quan la sessió ha executat més d'un pas AML; si no s'especifica,
            s'utilitza el cribratge AML més recent. Un node desconegut fa que la
            crida retorni `404`.
          schema:
            type: string
            example: feature_aml_1
        - name: month
          in: query
          required: false
          description: >-
            Un mes natural UTC en format `YYYY-MM`. Només es retornen els
            cribratges completats en aquest mes; sense ell, es retornen tots els
            mesos. Un mes amb un format incorrecte retorna `400`.
          schema:
            type: string
            pattern: ^\d{4}-(0[1-9]|1[0-2])$
            example: 2026-09
        - name: limit
          in: query
          required: false
          description: >-
            Nombre màxim d'execucions de cribratge per pàgina. Per defecte és
            50. Un valor inferior a 1 o un valor no numèric torna al valor
            predeterminat de 50; un valor superior a 1,000,000 retorna `400`.
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
            example: 50
        - name: offset
          in: query
          required: false
          description: >-
            Nombre de resultats que cal ometre abans del primer retornat. Per
            defecte és 0; un valor negatiu o no numèric torna a 0, un valor
            superior a 1,000,000 retorna `400`. És preferible seguir els URL
            `next` i `previous`.
          schema:
            type: integer
            default: 0
            minimum: 0
            maximum: 1000000
            example: 0
        - name: ordering
          in: query
          required: false
          description: >-
            Anul·lació opcional de l'ordenació. L'ordre predeterminat és
            `-completed_at`. Passa el nom d'un camp de resultat (per exemple
            `completed_at`, `started_at`, `outcome` o `score`) per ordenar de
            manera ascendent, afegeix-li el prefix `-` per ordenar de manera
            descendent i separa diversos camps amb comes. Els camps desconeguts
            s'ignoren.
          schema:
            type: string
            example: completed_at
      responses:
        '200':
          description: Una pàgina d'execucions de cribratge, les més recents primer.
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - next
                  - previous
                  - results
                properties:
                  count:
                    type: integer
                    maximum: 100
                    description: >-
                      Nombre d'execucions, exacte fins a 100 i limitat a 100 per
                      sobre d'aquest valor.
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: URL de la pàgina següent, o `null` a l'última pàgina.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: URL de la pàgina anterior, o `null` a la primera 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` o `offset` supera 1,000,000 (una matriu JSON amb un
            missatge), o `month` no és un mes natural `YYYY-MM` (un objecte amb
            la clau `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: >-
            La clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna
            `401`: una clau absent, no vàlida o revocada retorna `403`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Missatge d'error fàcil de llegir.
              examples:
                Expired key:
                  summary: La data de caducitat de la clau ha passat
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Fallada d'autenticació o d'autorització. Si falta la clau es retorna
            `403`, igual que amb una clau d'una altra aplicació, una clau amb
            àmbit sense el permís que necessita aquest endpoint o una
            sol·licitud des de fora de la llista d'adreces IP permeses de la
            clau; una clau incorrecta, revocada o caducada retorna `401`.
            Distingeix-les pel camp `detail`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Missatge d'error fàcil de llegir.
              examples:
                Missing or invalid credentials:
                  summary: >-
                    Falta la capçalera x-api-key, o la clau ha fallat la
                    validació
                  value:
                    detail: >-
                      Authentication credentials were not provided or are
                      invalid.
                Other application:
                  summary: >-
                    Una clau vàlida que pertany a una aplicació diferent de la
                    de la sessió
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without decisions read:
                  summary: >-
                    A la clau amb abast li manca el permís de lectura de
                    decisions
                  value:
                    detail: This API key has no read access to decisions.
                IP not allowed:
                  summary: >-
                    Sol·licitud des de fora de la llista d'adreces IP permeses
                    de la clau
                  value:
                    detail: This API key can't be used from this IP address.
        '404':
          description: >-
            La sessió no existeix, s'ha suprimit o queda fora dels límits d'una
            clau amb abast limitat, o no té cap comprovació AML (per al
            `node_id` indicat). La cerca de la sessió s'executa abans de
            comprovar les credencials, de manera que un `sessionId` desconegut
            retorna `404` fins i tot sense una clau vàlida.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Missatge d'error fàcil de llegir.
              examples:
                Unknown session:
                  summary: No existeix cap sessió amb aquest ID, o s'ha suprimit
                  value:
                    detail: Not found.
                Outside key limits:
                  summary: >-
                    La sessió queda fora dels límits d'una clau amb abast
                    limitat (també es retorna per a una sessió suprimida fa uns
                    moments)
                  value:
                    detail: Session not found.
                No AML check:
                  summary: La sessió no ha executat mai cap pas d'AML
                  value:
                    detail: The session does not have an AML check.
                No AML check for node:
                  summary: node_id no coincideix amb cap comprovació AML de la sessió
                  value:
                    detail: >-
                      The session does not have an AML check for node
                      'feature_aml_2'.
        '429':
          description: >-
            S'ha superat el límit de freqüència: 600 sol·licituds GET per minut
            per clau d'API. Espera els segons indicats a `Retry-After` abans de
            reintentar; les capçaleres `X-RateLimit-*` mostren el pressupost.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Missatge d'error fàcil de llegir.
              examples:
                Rate limited:
                  summary: Pressupost per al minut actual esgotat
                  value:
                    detail: >-
                      GET request rate limit exceeded. You can make up to 600
                      requests per minute.
          headers:
            Retry-After:
              description: Segons que cal esperar abans de reintentar.
              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: Un nou cribratge completat de monitoratge continu d'una comprovació 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 d'aquesta execució de cribratge.
        run_id:
          type: string
          format: uuid
          description: >-
            L'execució de monitoratge a la qual pertany aquest cribratge. Totes
            les verificacions sotmeses a cribratge en la mateixa execució la
            comparteixen.
        completed_at:
          type: string
          format: date-time
          description: >-
            Quan va finalitzar el recribratge d'aquest subjecte. Els resultats
            s'ordenen segons aquest valor, primer els més recents.
        started_at:
          type: string
          format: date-time
          description: >-
            Quan va començar el lot de monitoratge al qual pertany aquest
            recribratge.
        outcome:
          type: string
          enum:
            - NO_CHANGE
            - CHANGED
            - FAILED
          description: >-
            `NO_CHANGE`: completat i el resultat no ha variat. `CHANGED`:
            completat i la puntuació, l'estat, el recompte de coincidències o
            les coincidències han canviat. `FAILED`: cap resposta utilitzable
            per a aquest subjecte, de manera que la comprovació s'ha deixat tal
            com estava.
        trigger:
          type: string
          enum:
            - ONGOING_MONITORING
          description: Què va iniciar el cribratge. Sempre `ONGOING_MONITORING` actualment.
        provider:
          type: string
          description: >-
            Identificador opac de la font de dades d'AML que ha respost.
            Tracta'l com una cadena opaca; no hi facis bifurcacions.
          example: aml_data_source
        status:
          type: string
          nullable: true
          enum:
            - Not Finished
            - Approved
            - Declined
            - In Review
            - Resub Requested
            - null
          description: >-
            Estat de la comprovació AML en què ha quedat la comprovació després
            d'aquesta execució.
        score:
          type: number
          format: float
          nullable: true
          minimum: 0
          maximum: 100
          description: >-
            Puntuació AML amb què ha quedat la comprovació després d'aquesta
            execució.
        total_hits:
          type: integer
          nullable: true
          description: >-
            Nombre de coincidències que aquesta execució ha deixat a la
            comprovació.
        new_hits:
          type: integer
          nullable: true
          description: >-
            Nombre de coincidències que ha trobat aquesta execució i que la
            comprovació no tenia abans. `0` quan no s'ha trobat res nou; `null`
            quan l'execució ha fallat o s'ha registrat abans que existís aquest
            recompte.
        entities_screened:
          type: integer
          minimum: 0
          maximum: 1
          description: >-
            Nombre d'entitats que aquesta execució ha analitzat per a la
            verificació: `1` quan s'ha analitzat el subjecte, `0` quan
            l'execució ha fallat.
        dataset_freshness:
          allOf:
            - $ref: '#/components/schemas/AMLDatasetFreshness'
          nullable: true
          description: >-
            Actualitat del conjunt de dades en què es basa aquesta execució, o
            `null` quan no hi havia dates disponibles.
    AMLDatasetFreshness:
      type: object
      description: >-
        Com d'actualitzats estaven els conjunts de dades AML quan es va executar
        un cribratge. Les dates no s'estimen mai.
      required:
        - captured_at
        - provider
        - catalog_version
        - sources
      properties:
        captured_at:
          type: string
          format: date-time
          description: >-
            Quan Didit ha llegit el catàleg de conjunts de dades d'on prové
            aquesta frescor de les dades.
        provider:
          type: string
          description: >-
            Identificador opac de la font de dades d'AML. Tracta'l com una
            cadena opaca; no hi facis bifurcacions.
          example: aml_data_source
        catalog_version:
          type: string
          nullable: true
          description: >-
            Identificador de versió del catàleg de conjunts de dades, quan la
            font en reporta un.
        sources:
          type: object
          description: >-
            Grau d'actualització per família de conjunts de dades. Si els
            conjunts de dades d'una família no han informat de cap data
            d'actualització, s'omet en lloc d'omplir-se amb `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: Grau d'actualització d'una família de conjunts de dades d'AML.
      required:
        - last_updated_at
        - oldest_updated_at
        - dataset_count
        - dated_dataset_count
      properties:
        last_updated_at:
          type: string
          format: date-time
          description: >-
            Actualització més recent de qualsevol conjunt de dades de la
            família.
        oldest_updated_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Límit d'antiguitat: tots els conjunts de dades de la família estan
            com a mínim així d'actualitzats. `null` quan almenys un conjunt de
            dades de la família no ha informat de cap data d'actualització, ja
            que en aquest cas el límit és desconegut.
        dataset_count:
          type: integer
          description: Nombre de conjunts de dades a la família.
        dated_dataset_count:
          type: integer
          description: >-
            Nombre d'aquests conjunts de dades que han informat d'una data
            d'actualització.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clau d'API de la teva aplicació, des de Developers -> API keys a la
        Business Console. La clau primària té accés complet. Una clau amb nom
        pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
        limitada a determinats fluxos de treball o a sessions aprovades, a una
        llista d'adreces IP i a una data de caducitat. 401 significa que la clau
        és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
        clau, que la clau no té accés a aquest recurs o acció, o que la
        sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
        ruta de sessió significa que la sessió està fora dels fluxos de treball
        o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
        URL d'imatge, vídeo i PDF com a null, i una clau sense permís
        d'escriptura de sessions rep els enllaços de sessió i els tokens com a
        null. Consulta https://docs.didit.me/console/api-keys.

````

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