Récupérer une liste de conformité : API Didit

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

Récupérez les détails d’une liste, y compris son nombre d’entrées et la date d’ajout de son entrée la plus récente. Une liste appartenant à une autre application, ou une liste supprimée, renvoie 404. Pour lire les valeurs de la liste, utilisez Entrées de liste.

Autorisations

x-api-key

string

header

requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

Paramètres de chemin

list_uuid

string<uuid>

requis

UUID de la liste, tel que renvoyé par Lister les listes ou Créer une liste.

Réponse

La liste.

Une liste de blocage, une liste d'autorisation ou une liste personnalisée d'une application.

uuid

string<uuid>

requis

Identifiant de liste. Utilisez-le comme list_uuid dans les endpoints de liste et d'entrée, et comme valeur d'une condition de règle de workflow ou de transaction avec value_type: "list".

name

string

requis

Nom de la liste, unique parmi les listes de l'application.

Maximum string length: 255

description

string

requis

Description en texte libre. Chaîne vide lorsqu'elle n'est pas définie.

list_type

enum<string>

requis

blocklist : une correspondance refuse la session ou la transaction (listes système uniquement, une par type d'entrée). allowlist : les éléments correspondants sont considérés comme fiables, par exemple une liste d'autorisation de visages ignore l'action de visage dupliqué ; ne prévaut jamais sur une correspondance de liste de blocage. custom : utilisé dans les conditions de règles de transaction et de workflow (value_type: "list").

Options disponibles:

blocklist,

allowlist,

custom

entry_type

enum<string>

requis

Ce que contient la liste : face, document (numéro de document), phone, email, ip_address (adresse ou plage CIDR), device_fingerprint, wallet_address, bank_account, country (ISO 3166-1 alpha-3), user ou business (vos vendor_data), ou key (toute chaîne). Cela détermine la manière dont les valeurs des entrées sont validées et mises en correspondance.

Options disponibles:

face,

document,

phone,

email,

ip_address,

device_fingerprint,

wallet_address,

bank_account,

country,

user,

business,

key

is_system

boolean

requis

true pour les listes configurées par Didit : une liste de blocage par type d'entrée (face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, user, business), la liste personnalisée High Risk Countries et les listes d'autorisation du système. Les listes système ne peuvent être ni renommées, ni modifiées, ni supprimées ; vous pouvez ajouter et supprimer leurs entrées.

entry_count

integer

requis

Nombre d'entrées actuellement dans la liste.

Plage requise: x >= 0

last_entry_added_at

string<date-time> | null

requis

Moment où l'entrée actuelle la plus récente a été ajoutée. null pour une liste vide.

created_at

string<date-time>

requis

Moment où la liste a été créée.

updated_at

string<date-time>

requis

Moment où la liste a été mise à jour pour la dernière fois.

Dernière modification le 7 novembre 2026