> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # Criar lista via API: lista de permissões e personalizada > Crie uma lista de permissões ou personalizada na Didit via POST /v3/lists/. Listas de bloqueio do sistema são automáticas. Sem contratos. Prompt da API para criar lista Copiar o prompt para a área de transferência \

\`Create a new allowlist or custom list in my Didit application through the Management API.

Endpoint:
POST https://verification.didit.me/v3/lists/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs workflows: write.

Goal:
\- Create an allowlist (matching items are treated as trusted, for example to skip a duplicated-face or duplicated-IP action; it never overrides a blocklist match) or a custom list (for workflow conditions, transaction rules, or manual review).
\- System blocklists are provisioned by Didit, one per entry type. You cannot create a blocklist.

Request body (application/json):
\{
"name": "Trusted office IPs",          // required, at most 255 characters, unique among the application's lists
"description": "Office egress ranges", // optional
"list_type": "allowlist",              // required: "allowlist" or "custom"
"entry_type": "ip_address"             // required: face | document | phone | email | ip_address | device_fingerprint | wallet_address | bank_account | country | user | business | key
}

entry_type is fixed once the list exists: it decides how entry values are validated and matched.

Example call:
curl -X POST "https://verification.didit.me/v3/lists/" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Trusted office IPs", "list_type": "allowlist", "entry_type": "ip_address"}'

Example response (201):
\{
"uuid": "66666666-7777-8888-9999-000000000000",
"name": "Trusted office IPs",
"description": "",
"list_type": "allowlist",
"entry_type": "ip_address",
"is_system": false,
"entry_count": 0,
"last_entry_added_at": null,
"created_at": "2026-10-12T09:15:44.031876Z",
"updated_at": "2026-10-12T09:15:44.031876Z"
}

Persist the returned uuid: use it as list_uuid in the entry calls, and as the value of a workflow or transaction rule condition with value_type "list".

Failure modes:
\- 400: list_type is "blocklist", a required field is missing, name is longer than 255 characters, entry_type is unknown, or another list of the application already has this name ({ "name": ["A list with this name already exists for this application."] }).
\- 401: the API key has expired.
\- 403: missing x-api-key (a wrong, revoked or expired key gets 401) ({ "detail": "You do not have permission to perform this action." }), or a scoped key without workflows: write.
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects:
\- Creates a new list in the application the API key belongs to.

For the full integration shape, see /integration/integration-prompt.`

\
Colar em 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](https://docs.didit.me/pt/management-api/lists/create-entry.md).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](https://docs.didit.me/pt/management-api/lists/overview.md) para saber o que faz cada tipo de lista. ## OpenAPI ````yaml pt/openapi-25.json POST /v3/lists/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de Verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/lists/: post: tags: - Lists summary: Criar uma lista description: >- Cria uma lista de permissões ou uma lista personalizada na aplicação à qual a chave de API pertence. As listas de bloqueio não podem ser criadas: a Didit disponibiliza uma lista de bloqueio do sistema por tipo de entrada, à qual adiciona itens com [Criar uma entrada de lista](https://docs.didit.me/pt/management-api/lists/create-entry). O `entry_type` não pode ser alterado após a criação e determina como os valores de entrada são validados e correspondidos. As entradas da lista de permissões marcam os itens correspondentes como fidedignos (por exemplo, uma lista de permissões de rostos ignora a ação de rosto duplicado) e nunca sobrepõem uma correspondência com a lista de bloqueio; faça referência a qualquer lista a partir de uma condição de regra de fluxo ou de transação com `value_type: "list"`. Uma chave de API com âmbito necessita de `workflows: write`. operationId: create_list requestBody: required: true content: application/json: schema: type: object required: - name - list_type - entry_type properties: name: type: string minLength: 1 maxLength: 255 description: >- Nome da lista. Deve ser diferente do nome de todas as outras listas da aplicação, incluindo listas do sistema. description: type: string default: '' description: Descrição de texto livre opcional. list_type: type: string enum: - allowlist - custom description: '`allowlist` ou `custom`. `blocklist` é recusada com `400`.' entry_type: type: string enum: - face - document - phone - email - ip_address - device_fingerprint - wallet_address - bank_account - country - user - business - key description: >- 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. examples: IP allowlist: value: name: Trusted office IPs description: Office egress ranges list_type: allowlist entry_type: ip_address Custom country list: value: name: Enhanced due diligence countries list_type: custom entry_type: country responses: '201': description: A lista foi criada. content: application/json: schema: $ref: '#/components/schemas/ComplianceList' examples: New allowlist: value: uuid: 22222222-3333-4444-5555-666666666666 name: Trusted office IPs description: Office egress ranges list_type: allowlist entry_type: ip_address is_system: false entry_count: 0 last_entry_added_at: null created_at: '2026-10-12T09:15:44.031876Z' updated_at: '2026-10-12T09:15:44.031876Z' '400': description: O corpo é inválido. content: application/json: examples: Blocklist refused: value: list_type: - >- Cannot create additional blocklist lists. System blocklists are auto-created for each application. Duplicate name: value: name: - >- A list with this name already exists for this application. Missing fields: value: name: - This field is required. list_type: - This field is required. entry_type: - This field is required. Unknown entry type: value: entry_type: - '"iban" is not a valid choice.' Name too long: value: name: - Ensure this field has no more than 255 characters. '401': description: >- A chave de API com âmbito expirou. Outras falhas de autenticação devolvem `403`. content: application/json: examples: Expired API key: value: detail: This API key has expired. '403': description: >- O cabeçalho `x-api-key` está em falta (uma chave errada, revogada ou expirada recebe `401`), ou uma chave de API com âmbito não tem `workflows: write` ou é utilizada a partir de um endereço IP fora da sua lista de permissões. content: application/json: examples: Missing or invalid API key: value: detail: You do not have permission to perform this action. Scoped key without workflows access: value: detail: This API key has no write access to workflows. '429': $ref: '#/components/responses/RateLimitedWrite' security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: |- curl -X POST 'https://verification.didit.me/v3/lists/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "name": "Trusted office IPs", "description": "Office egress ranges", "list_type": "allowlist", "entry_type": "ip_address" }' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.lists.create( name="Trusted office IPs", description="Office egress ranges", list_type="allowlist", entry_type="ip_address", ) print(result) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.lists.create({ name: "Trusted office IPs", description: "Office egress ranges", list_type: "allowlist", entry_type: "ip_address", }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Create(ctx, didit.ListsCreateParams{\n\tName: \"Trusted office IPs\",\n\tDescription: didit.String(\"Office egress ranges\"),\n\tListType: \"allowlist\",\n\tEntryType: \"ip_address\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: |- import me.didit.Didit; import me.didit.types.ListsCreateParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.lists().create(ListsCreateParams.builder() .name("Trusted office IPs") .description("Office egress ranges") .listType(ListsCreateParams.ListType.of("allowlist")) .entryType(ListsCreateParams.EntryType.of("ip_address")) .build()); System.out.println(result); - lang: php label: PHP source: |- lists->create([ 'name' => 'Trusted office IPs', 'description' => 'Office egress ranges', 'list_type' => 'allowlist', 'entry_type' => 'ip_address', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.lists.create( name: "Trusted office IPs", description: "Office egress ranges", list_type: "allowlist", entry_type: "ip_address" ) puts result.to_h - lang: csharp label: .NET source: |- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Lists.CreateAsync(new ListsCreateParams { Name = "Trusted office IPs", Description = "Office egress ranges", ListType = "allowlist", EntryType = "ip_address", }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: ComplianceList: type: object description: >- Uma lista de bloqueio, lista de permissões ou lista personalizada de uma aplicação. required: - uuid - name - description - list_type - entry_type - is_system - entry_count - last_entry_added_at - created_at - updated_at properties: uuid: type: string format: uuid description: >- 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: type: string maxLength: 255 description: Nome da lista, único entre as listas da aplicação. description: type: string description: Descrição em texto livre. String vazia quando não definida. list_type: type: string enum: - blocklist - allowlist - custom description: >- `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"`). entry_type: type: string enum: - face - document - phone - email - ip_address - device_fingerprint - wallet_address - bank_account - country - user - business - key description: >- 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. is_system: type: boolean description: >- `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: type: integer minimum: 0 description: Número de entradas atualmente na lista. last_entry_added_at: type: string format: date-time nullable: true description: >- Quando a entrada atual mais recente foi adicionada. `null` para uma lista vazia. created_at: type: string format: date-time description: Quando a lista foi criada. updated_at: type: string format: date-time description: Quando a lista foi atualizada pela última vez. responses: RateLimitedWrite: description: >- O limite de escrita partilhado de 300 pedidos por minuto por chave de API foi excedido. Respeite o `Retry-After` antes de tentar novamente. content: application/json: schema: type: object required: - detail properties: detail: type: string example: detail: >- Write request rate limit exceeded. You can make up to 300 requests per minute. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.