Saltar para o conteúdo principal
POST
curl
Crie uma lista para a sua aplicação. Só é possível criar listas allowlist e custom: a Didit disponibiliza uma lista de bloqueio do sistema por tipo de entrada, à qual pode adicionar entradas através de Criar entrada. Escolha entry_type com cuidado: não pode ser alterado mais tarde e determina a forma como cada valor é validado quando o adiciona. Consulte Listas para saber o que faz cada tipo de lista.

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.

Corpo

application/json
name
string
obrigatório

Nome da lista. Deve ser diferente do nome de todas as outras listas da aplicação, incluindo listas do sistema.

Required string length: 1 - 255
list_type
enum<string>
obrigatório

allowlist ou custom. blocklist é recusada com 400.

Opções disponíveis:
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 alfa-3), user ou business (o seu vendor_data), ou key (qualquer cadeia de carateres). Determina como os valores de entrada são validados e correspondidos. Não pode ser alterado posteriormente.

Opções disponíveis:
face,
document,
phone,
email,
ip_address,
device_fingerprint,
wallet_address,
bank_account,
country,
user,
business,
key
description
string
padrão:""

Descrição de texto livre opcional.

Resposta

A lista foi criada.

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

uuid
string<uuid>
obrigatório

Identificador da lista. Utilize-o como list_uuid nos endpoints de listas e entradas, e como o 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 (apenas listas do sistema, uma por tipo de entrada). allowlist: os elementos correspondentes são considerados fiáveis, por exemplo, uma lista de permissões faciais ignora a ação de rosto duplicado; nunca substitui uma correspondência de lista de bloqueio. custom: usado 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 alfa-3), user ou business (o seu vendor_data), ou key (qualquer cadeia de carateres). Determina como os valores de entrada são validados e correspondidos.

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 fornecidas pela Didit: 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 ou eliminadas; pode adicionar e eliminar as suas entradas.

entry_count
integer
obrigatório

Número de entradas atualmente na lista.

Intervalo necessá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 7 de novembro de 2026