Compliance-Liste abrufen: Get List API

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

Rufen Sie die Details einer Liste ab, einschließlich der Anzahl ihrer Einträge und des Zeitpunkts, zu dem der neueste Eintrag hinzugefügt wurde. Eine Liste einer anderen Anwendung oder eine gelöschte Liste gibt 404 zurück. Um die Werte in der Liste zu lesen, verwenden Sie Listeneinträge.

Autorisierungen

x-api-key

string

header

erforderlich

Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.

Pfadparameter

list_uuid

string<uuid>

erforderlich

UUID der Liste, wie sie von „Listen auflisten“ oder „Liste erstellen“ zurückgegeben wird.

Antwort

Die Liste.

Eine Sperrliste, Positivliste oder benutzerdefinierte Liste einer Anwendung.

uuid

string<uuid>

erforderlich

Listen-Identifikator. Verwenden Sie ihn als list_uuid in den Listen- und Eintrag-Endpoints sowie als Wert einer Workflow- oder Transaktionsregel-Bedingung mit value_type: "list".

name

string

erforderlich

Listenname, eindeutig unter den Listen der Anwendung.

Maximum string length: 255

description

string

erforderlich

Freitext-Beschreibung. Leere Zeichenkette, wenn nicht festgelegt.

list_type

enum<string>

erforderlich

blocklist: Eine Übereinstimmung lehnt die Sitzung oder Transaktion ab (nur Systemlisten, eine pro Eintragstyp). allowlist: Übereinstimmende Elemente gelten als vertrauenswürdig, beispielsweise überspringt eine Gesichts-Allowlist die Aktion für doppelte Gesichter; überschreibt niemals eine Sperrlisten-Übereinstimmung. custom: Wird in Workflow- und Transaktionsregel-Bedingungen verwendet (value_type: "list").

Verfügbare Optionen:

blocklist,

allowlist,

custom

entry_type

enum<string>

erforderlich

Was die Liste enthält: face, document (Dokumentennummer), phone, email, ip_address (Adresse oder CIDR-Bereich), device_fingerprint, wallet_address, bank_account, country (ISO 3166-1 Alpha-3), user oder business (Ihre vendor_data) oder key (eine beliebige Zeichenkette). Damit wird bestimmt, wie Eintragswerte validiert und abgeglichen werden.

Verfügbare Optionen:

face,

document,

phone,

email,

ip_address,

device_fingerprint,

wallet_address,

bank_account,

country,

user,

business,

key

is_system

boolean

erforderlich

true für die von Didit bereitgestellten Listen: eine Sperrliste pro Eintragstyp (face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, user, business), die benutzerdefinierte Liste High Risk Countries und System-Positivlisten. Systemlisten können weder umbenannt noch bearbeitet oder gelöscht werden; Sie können deren Einträge hinzufügen und löschen.

entry_count

integer

erforderlich

Anzahl der Einträge, die sich derzeit in der Liste befinden.

Erforderlicher Bereich: x >= 0

last_entry_added_at

string<date-time> | null

erforderlich

Wann der neueste aktuelle Eintrag hinzugefügt wurde. null bei einer leeren Liste.

created_at

string<date-time>

erforderlich

Wann die Liste erstellt wurde.

updated_at

string<date-time>

erforderlich

Wann die Liste zuletzt aktualisiert wurde.

Zuletzt geändert am 7. November 2026