Histórico de Triagem AML: API de Listagem

curl

curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/aml-screening-history/' \
  -H 'x-api-key: YOUR_API_KEY'

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);
}

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

iter := client.Sessions.ListAMLScreeningHistoryAutoPaging(ctx, "11111111-2222-3333-4444-555555555555", didit.SessionsListAMLScreeningHistoryParams{})
for iter.Next() {
	fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
	log.Fatal(err)
}

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);
}

<?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());
}

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));
}

{
  "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
    }
  ]
}

GET

session

{sessionId}

aml-screening-history

curl

curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/aml-screening-history/' \
  -H 'x-api-key: YOUR_API_KEY'

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);
}

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

iter := client.Sessions.ListAMLScreeningHistoryAutoPaging(ctx, "11111111-2222-3333-4444-555555555555", didit.SessionsListAMLScreeningHistoryParams{})
for iter.Next() {
	fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
	log.Fatal(err)
}

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);
}

<?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());
}

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));
}

{
  "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
    }
  ]
}

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

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

sessionId

string<uuid>

obrigatório

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.

Exemplo:

"11111111-2222-3333-4444-555555555555"

Parâmetros de consulta

node_id

string

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.

Exemplo:

"feature_aml_1"

month

string

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.

Pattern: ^\d{4}-(0[1-9]|1[0-2])$

Exemplo:

"2026-09"

limit

integer

padrão:50

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.

Intervalo necessário: 1 <= x <= 1000000

Exemplo:

50

offset

integer

padrão:0

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.

Intervalo necessário: 0 <= x <= 1000000

Exemplo:

0

ordering

string

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.

Exemplo:

"completed_at"

Resposta

Uma página de execuções de triagem, as mais recentes primeiro.

count

integer

obrigatório

Número de execuções, exato até 100 e limitado a 100 acima desse valor.

Intervalo necessário: x <= 100

string<uri> | null

obrigatório

URL da página seguinte, ou null na última página.

string<uri> | null

obrigatório

URL da página anterior, ou null na primeira página.

results

object[]

obrigatório

Show child attributes

Última modificação em 7 de novembro de 2026