Saltar para o conteúdo principal
GET
curl
Obtém as entradas de uma lista, das mais recentes para as mais antigas, com pesquisa opcional. search corresponde a parte do valor ou da etiqueta de uma entrada, sem distinguir maiúsculas de minúsculas. reference_session_id restringe os resultados às entradas obtidas de uma sessão de verificação. Numa lista facial, metadata.face_image_source indica a qual das faces da sessão corresponde cada entrada (liveness quando está ausente). As entradas faciais e de documentos incluem, em metadata, URLs de imagens que expiram pouco depois da chamada. Obtenha as entradas novamente para receber URLs novos, em vez de os armazenar. Uma chave de API sem media: read recebe null nesses URLs.

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. 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.

Parâmetros de consulta

Texto insensível a maiúsculas/minúsculas que o value ou display_label da entrada deve conter.

reference_session_id
string<uuid>

Apenas as entradas recolhidas a partir desta sessão de verificação de pessoa, por exemplo para consultar quais dos seus rostos já estão listados.

limit
integer
padrão:50

Tamanho da página. A predefinição é 50. Um valor superior a 1000000 devolve 400; zero, um valor negativo ou um valor não numérico reverte para 50.

Intervalo necessário: 1 <= x <= 1000000
offset
integer
padrão:0

Índice de base zero do primeiro item a devolver. Prefira seguir next. Um valor superior a 1000000 devolve 400; um valor negativo ou não numérico reverte para 0.

Intervalo necessário: 0 <= x <= 1000000

Resposta

Uma página de entradas, as mais recentes primeiro.

count
integer
obrigatório

Número total de entradas correspondentes aos filtros.

Intervalo necessário: x >= 0
next
string<uri> | null
obrigatório

URL absoluto da página seguinte, ou null na última página.

previous
string<uri> | null
obrigatório

URL absoluto da página anterior, ou null na primeira página.

results
object[]
obrigatório
Última modificação em 7 de novembro de 2026