Pular para o conteúdo principal
GET
curl
Recupere as entradas de uma lista, das mais recentes para as mais antigas, com busca opcional. search encontra parte do valor ou do rótulo de uma entrada, sem diferenciar maiúsculas de minúsculas; reference_session_id restringe os resultados às entradas obtidas de uma sessão de verificação. Em uma lista de rostos, metadata.face_image_source indica a qual dos rostos da sessão cada entrada corresponde (liveness quando ausente). As entradas de rosto e de documento trazem em metadata URLs de imagem que expiram pouco depois da chamada. Busque as entradas novamente para obter URLs atualizadas, em vez de armazená-las. Para uma chave de API sem media: read, essas URLs têm o valor null.

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.

Parâmetros de consulta

Texto, sem distinção entre maiúsculas e minúsculas, que o value ou o display_label da entrada deve conter.

reference_session_id
string<uuid>

Somente as entradas extraídas desta sessão de verificação de pessoa, por exemplo para ver quais de seus rostos já estão listados.

limit
integer
padrão:50

Tamanho da página. O padrão é 50. Um valor acima de 1000000 retorna 400; zero, um valor negativo ou não numérico volta para 50.

Intervalo obrigatório: 1 <= x <= 1000000
offset
integer
padrão:0

Índice, a partir de zero, do primeiro item a retornar. Prefira seguir next. Um valor acima de 1000000 retorna 400; um valor negativo ou não numérico passa a ser 0.

Intervalo obrigatório: 0 <= x <= 1000000

Resposta

Uma página de entradas, da mais recente para a mais antiga.

count
integer
obrigatório

Número total de entradas que correspondem aos filtros.

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

URL absoluta da próxima página, ou null na última página.

previous
string<uri> | null
obrigatório

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

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