Pular para o conteúdo principal
POST
curl
Crie uma lista para a sua aplicação. Somente listas allowlist e custom podem ser criadas: a Didit provisiona uma lista de bloqueio do sistema para cada tipo de entrada, e você adiciona itens a ela com Criar entrada. Escolha o entry_type com cuidado: ele não pode ser alterado depois e determina como cada valor é validado quando você o adiciona. Veja Listas para saber o que cada tipo de lista faz.

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.

Corpo

application/json
name
string
obrigatório

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

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

allowlist ou custom. blocklist é recusado 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 alpha-3), user ou business (seu vendor_data), ou key (qualquer string). Define como os valores das entradas são validados e comparados. Não pode ser alterado depois.

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 opcional em texto livre.

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. 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