Obtenir llista API: consultar una llista de compliment

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

Obtén els detalls d’una llista, incloent-hi el nombre d’entrades i quan s’hi va afegir l’entrada més recent. Una llista d’una altra aplicació, o una llista que s’ha eliminat, retorna 404. Per llegir els valors de la llista, fes servir Entrades de la llista.

Autoritzacions

x-api-key

string

header

requerit

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.

Paràmetres de ruta

list_uuid

string<uuid>

requerit

UUID de la llista, tal com el retorna Llistar llistes o Crear una llista.

Resposta

La llista.

Una llista de bloqueig, llista de permesos o llista personalitzada d'una aplicació.

uuid

string<uuid>

requerit

Identificador de la llista. Utilitza'l com a list_uuid als endpoints de llistes i entrades, i com a valor d'una condició de regla de flux de treball o de transacció amb value_type: "list".

name

string

requerit

Nom de la llista, únic entre les llistes de l'aplicació.

Maximum string length: 255

description

string

requerit

Descripció de text lliure. Cadena buida si no s'ha definit.

list_type

enum<string>

requerit

blocklist: una coincidència rebutja la sessió o la transacció (només llistes del sistema, una per tipus d'entrada). allowlist: els elements coincidents són de confiança; per exemple, una llista d'autorització facial omet l'acció de detecció de cares duplicades; mai no anul·la una coincidència amb una llista de bloqueig. custom: s'utilitza en condicions de regles de fluxos de treball i transaccions (value_type: "list").

Opcions disponibles:

blocklist,

allowlist,

custom

entry_type

enum<string>

requerit

Què conté la llista: face, document (número de document), phone, email, ip_address (adreça o rang CIDR), device_fingerprint, wallet_address, bank_account, country (ISO 3166-1 alpha-3), user o business (el teu vendor_data), o key (qualsevol cadena). Decideix com es validen i es comparen els valors de les entrades.

Opcions disponibles:

face,

document,

phone,

email,

ip_address,

device_fingerprint,

wallet_address,

bank_account,

country,

user,

business,

key

is_system

boolean

requerit

true per a les llistes que Didit aprovisiona: una llista de bloqueig per tipus d'entrada (face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, user, business), la llista personalitzada High Risk Countries i les llistes d'admesos del sistema. Les llistes del sistema no es poden reanomenar, editar ni suprimir; pots afegir i suprimir les seves entrades.

entry_count

integer

requerit

Nombre d'entrades actualment a la llista.

Rang requerit: x >= 0

last_entry_added_at

string<date-time> | null

requerit

Quan es va afegir l'entrada actual més recent. null per a una llista buida.

created_at

string<date-time>

requerit

Quan es va crear la llista.

updated_at

string<date-time>

requerit

Quan es va actualitzar la llista per darrera vegada.

Darrera modificació el 7 de novembre del 2026