API Obter lista: consultar lista de conformidade

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

Obtenha os detalhes de uma lista, incluindo a quantidade de entradas e a data em que a entrada mais recente foi adicionada. Uma lista de outra aplicação, ou uma lista que foi excluída, retorna 404. Para ler os valores da lista, use Listar entradas.

Autorizações

x-api-key

string

header

obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

list_uuid

string<uuid>

obrigatório

UUID da lista, conforme retornado por Listar listas ou Criar uma lista.

Resposta

A lista.

Uma lista de bloqueio, lista de permissões ou lista personalizada de uma aplicação.

uuid

string<uuid>

obrigatório

Identificador da lista. Use-o como list_uuid nos endpoints de listas e de entradas, e como valor de uma condição de regra de fluxo ou de transação com value_type: "list".

name

string

obrigatório

Nome da lista, único entre as listas da aplicação.

Maximum string length: 255

description

string

obrigatório

Descrição em texto livre. String vazia quando não definida.

list_type

enum<string>

obrigatório

blocklist: uma correspondência recusa a sessão ou a transação (somente listas do sistema, uma por tipo de entrada). allowlist: os itens correspondentes são considerados confiáveis; por exemplo, uma allowlist de rostos ignora a ação de rosto duplicado; nunca prevalece sobre uma correspondência na lista de bloqueio. custom: usada em condições de regras de fluxo e de transação (value_type: "list").

Opções disponíveis:

blocklist,

allowlist,

custom

entry_type

enum<string>

obrigatório

O que a lista contém: face, document (número do documento), phone, email, ip_address (endereço IP ou intervalo CIDR), device_fingerprint, wallet_address, bank_account, country (ISO 3166-1 alpha-3), user ou business (seu vendor_data), ou key (qualquer string). Define como os valores das entradas são validados e comparados.

Opções disponíveis:

face,

document,

phone,

email,

ip_address,

device_fingerprint,

wallet_address,

bank_account,

country,

user,

business,

key

is_system

boolean

obrigatório

true para as listas que a Didit provisiona: uma lista de bloqueio por tipo de entrada (face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, user, business), a lista personalizada High Risk Countries e as listas de permissão do sistema. As listas do sistema não podem ser renomeadas, editadas nem excluídas; você pode adicionar e excluir as entradas delas.

entry_count

integer

obrigatório

Número de entradas atualmente na lista.

Intervalo obrigatório: x >= 0

last_entry_added_at

string<date-time> | null

obrigatório

Quando a entrada atual mais recente foi adicionada. null para uma lista vazia.

created_at

string<date-time>

obrigatório

Quando a lista foi criada.

updated_at

string<date-time>

obrigatório

Quando a lista foi atualizada pela última vez.

Última modificação em 1 de novembro de 2026