API Get List: consultar una lista de cumplimiento

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 los detalles de una lista, incluido su número de entradas y cuándo se añadió su entrada más reciente. Una lista de otra aplicación, o una que se eliminó, devuelve 404. Para leer los valores de la lista, usa Listar entradas.

Autorizaciones

x-api-key

string

header

requerido

La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Parámetros de ruta

list_uuid

string<uuid>

requerido

UUID de la lista, tal como lo devuelven Listar listas o Crear una lista.

Respuesta

La lista.

Una lista de bloqueo, lista de permitidos o lista personalizada de una aplicación.

uuid

string<uuid>

requerido

Identificador de la lista. Úsalo como list_uuid en los endpoints de listas y de entradas, y como valor de una condición de regla de flujo o de transacción con value_type: "list".

name

string

requerido

Nombre de la lista, único entre las listas de la aplicación.

Maximum string length: 255

description

string

requerido

Descripción en texto libre. Cadena vacía cuando no está definida.

list_type

enum<string>

requerido

blocklist: una coincidencia rechaza la sesión o la transacción (solo listas del sistema, una por tipo de entrada). allowlist: los elementos que coinciden se consideran de confianza; por ejemplo, una lista de permitidos de rostros omite la acción de rostro duplicado; nunca anula una coincidencia de una lista de bloqueo. custom: se usa en las condiciones de las reglas de flujos y de transacciones (value_type: "list").

Opciones disponibles:

blocklist,

allowlist,

custom

entry_type

enum<string>

requerido

Qué contiene la lista: face, document (número de documento), phone, email, ip_address (dirección IP o rango CIDR), device_fingerprint, wallet_address, bank_account, country (ISO 3166-1 alfa-3), user o business (tu vendor_data), o key (cualquier cadena). Determina cómo se validan y comparan los valores de las entradas.

Opciones disponibles:

face,

document,

phone,

email,

ip_address,

device_fingerprint,

wallet_address,

bank_account,

country,

user,

business,

key

is_system

boolean

requerido

true para las listas que crea Didit: una lista de bloqueo por tipo de entrada (face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, user, business), la lista personalizada High Risk Countries y las listas de permitidos del sistema. Las listas del sistema no se pueden renombrar, editar ni eliminar; puedes añadir y eliminar sus entradas.

entry_count

integer

requerido

Número de entradas que hay actualmente en la lista.

Rango requerido: x >= 0

last_entry_added_at

string<date-time> | null

requerido

Fecha y hora en que se añadió la entrada vigente más reciente. null si la lista está vacía.

created_at

string<date-time>

requerido

Fecha y hora en que se creó la lista.

updated_at

string<date-time>

requerido

Fecha y hora de la última actualización de la lista.

Última modificación el 1 de noviembre de 2026