API Get List: recupera lista di compliance

curl

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

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.lists.retrieve("11111111-2222-3333-4444-555555555555");
console.log(result);

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

result, err := client.Lists.Retrieve(ctx, "11111111-2222-3333-4444-555555555555")
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->lists->retrieve('11111111-2222-3333-4444-555555555555');
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Lists.RetrieveAsync("11111111-2222-3333-4444-555555555555");
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "uuid": "11111111-2222-3333-4444-555555555555",
  "name": "Face Blocklist",
  "description": "Blocked biometric faces. When a face matching an entry in this list is detected during liveness verification, the session will be automatically declined.",
  "list_type": "blocklist",
  "entry_type": "face",
  "is_system": true,
  "entry_count": 12,
  "last_entry_added_at": "2026-10-09T16:42:03.118204Z",
  "created_at": "2026-01-14T10:02:11.402917Z",
  "updated_at": "2026-01-14T10:02:11.402917Z"
}

GET

lists

{list_uuid}

curl

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

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.lists.retrieve("11111111-2222-3333-4444-555555555555");
console.log(result);

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

result, err := client.Lists.Retrieve(ctx, "11111111-2222-3333-4444-555555555555")
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->lists->retrieve('11111111-2222-3333-4444-555555555555');
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Lists.RetrieveAsync("11111111-2222-3333-4444-555555555555");
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "uuid": "11111111-2222-3333-4444-555555555555",
  "name": "Face Blocklist",
  "description": "Blocked biometric faces. When a face matching an entry in this list is detected during liveness verification, the session will be automatically declined.",
  "list_type": "blocklist",
  "entry_type": "face",
  "is_system": true,
  "entry_count": 12,
  "last_entry_added_at": "2026-10-09T16:42:03.118204Z",
  "created_at": "2026-01-14T10:02:11.402917Z",
  "updated_at": "2026-01-14T10:02:11.402917Z"
}

Recupera i dettagli di una lista, incluso il numero di voci e la data in cui è stata aggiunta la voce più recente. Una lista di un’altra applicazione, oppure una lista eliminata, restituisce 404. Per leggere i valori della lista, usa Voci della lista.

Autorizzazioni

x-api-key

string

header

obbligatorio

La chiave API della tua applicazione, da Developers -> API keys nella Business Console. La chiave primaria ha accesso completo. Una chiave con nome può avere un ambito definito: nessuno, lettura o scrittura per risorsa, limitata ad alcuni workflow o a sessioni approvate, a un elenco di indirizzi IP e a una data di scadenza. 401 indica che la chiave è errata, revocata o scaduta; 403 indica che non è stata inviata alcuna chiave, che la chiave non ha accesso a questa risorsa o azione, oppure che la richiesta proviene da un indirizzo non incluso nel suo elenco IP; 404 su una route di sessione indica che la sessione non rientra nei workflow o negli stati previsti dalla chiave. Una chiave senza accesso ai media riceve gli URL di immagini, video e PDF come null, e una chiave senza permessi di scrittura sulle sessioni riceve link e token di sessione come null. Consulta https://docs.didit.me/console/api-keys.

Parametri del percorso

list_uuid

string<uuid>

obbligatorio

UUID della lista, come restituito da List lists o Create a list.

Risposta

La lista.

Una blocklist, allowlist o lista personalizzata di un'applicazione.

uuid

string<uuid>

obbligatorio

Identificatore della lista. Utilizzalo come list_uuid negli endpoint di lista e voci, e come valore di una condizione di regola di workflow o transazione con value_type: "list".

name

string

obbligatorio

Nome della lista, univoco tra le liste dell'applicazione.

Maximum string length: 255

description

string

obbligatorio

Descrizione in formato testo libero. Stringa vuota se non impostata.

list_type

enum<string>

obbligatorio

blocklist: una corrispondenza rifiuta la sessione o la transazione (solo liste di sistema, una per tipo di voce). allowlist: gli elementi corrispondenti sono attendibili, ad esempio un'allowlist dei volti salta l'azione per volto duplicato; non sovrascrive mai una corrispondenza con la blocklist. custom: utilizzato nelle condizioni delle regole del workflow e delle transazioni (value_type: "list").

Opzioni disponibili:

blocklist,

allowlist,

custom

entry_type

enum<string>

obbligatorio

Cosa contiene la lista: face, document (numero del documento), phone, email, ip_address (indirizzo o intervallo CIDR), device_fingerprint, wallet_address, bank_account, country (ISO 3166-1 alpha-3), user o business (il tuo vendor_data), oppure key (qualsiasi stringa). Determina come vengono convalidati e confrontati i valori delle voci.

Opzioni disponibili:

face,

document,

phone,

email,

ip_address,

device_fingerprint,

wallet_address,

bank_account,

country,

user,

business,

key

is_system

boolean

obbligatorio

true per le liste predisposte da Didit: una blocklist per tipo di voce (face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, user, business), la lista personalizzata High Risk Countries e le allowlist di sistema. Le liste di sistema non possono essere rinominate, modificate o eliminate; puoi aggiungerne ed eliminarne le voci.

entry_count

integer

obbligatorio

Numero di voci attualmente presenti nella lista.

Intervallo richiesto: x >= 0

last_entry_added_at

string<date-time> | null

obbligatorio

Quando è stata aggiunta la voce corrente più recente. null per una lista vuota.

created_at

string<date-time>

obbligatorio

Quando la lista è stata creata.

updated_at

string<date-time>

obbligatorio

Quando la lista è stata aggiornata l'ultima volta.

Ultima modifica il 7 novembre 2026