> ## 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. # 创建名单 API：白名单与自定义名单 > POST /v3/lists/：为您的 Didit 应用创建新的白名单或自定义名单。系统黑名单自动预置。按次计费，无需签订合同。 创建列表 API 提示词 将提示词复制到剪贴板 \

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

\
粘贴到 为您的应用创建一个列表。只能创建 `allowlist` 和 `custom` 列表：Didit 为每种条目类型预置一个系统黑名单，您可以通过[创建条目](https://docs.didit.me/zh/management-api/lists/create-entry.md)向其中添加条目。请谨慎选择 `entry_type`：它创建后无法更改，并且决定了添加每个值时的验证方式。各类列表的作用请参阅[列表](https://docs.didit.me/zh/management-api/lists/overview.md)。 ## OpenAPI ````yaml zh/openapi-25.json POST /v3/lists/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: 身份证件验证 API。使用 x-api-key 请求头进行身份验证。 servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/lists/: post: tags: - Lists summary: 创建列表 description: >- 在 API 密钥所属的应用中创建白名单或自定义名单。无法创建黑名单：Didit 为每种条目类型预配一个系统黑名单，您可以通过[创建名单条目](https://docs.didit.me/zh/management-api/lists/create-entry)向其添加内容。`entry_type` 在创建后不可更改，并决定如何验证和匹配条目值。白名单条目将匹配项标记为可信（例如，人脸白名单会跳过重复人脸操作），且绝不会覆盖黑名单匹配；可使用 `value_type: "list"` 在工作流或交易规则条件中引用任意名单。限定权限范围的 API 密钥需要 `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: 名单名称。必须与该应用的所有其他名单名称不同，包括系统名单。 description: type: string default: '' description: 可选的自由文本描述。 list_type: type: string enum: - allowlist - custom description: '`allowlist` 或 `custom`。若为 `blocklist` 则以 `400` 拒绝。' entry_type: type: string enum: - face - document - phone - email - ip_address - device_fingerprint - wallet_address - bank_account - country - user - business - key description: >- 该名单包含的内容：`face`、`document`（证件号码）、`phone`、`email`、`ip_address`（IP 地址或 CIDR 范围）、`device_fingerprint`、`wallet_address`、`bank_account`、`country`（ISO 3166-1 alpha-3）、`user` 或 `business`（您的 `vendor_data`），或 `key`（任意字符串）。它决定了条目值的验证和匹配方式。后续无法更改。 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: 名单已创建。 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: 请求体无效。 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: 作用域 API 密钥已过期。其他身份验证失败将返回 `403`。 content: application/json: examples: Expired API key: value: detail: This API key has expired. '403': description: >- 缺少 `x-api-key` 请求头（错误、已撤销或已过期的密钥会返回 `401`），或者限定权限的 API 密钥缺少 `workflows: write`，抑或是从其允许名单之外的 IP 地址使用。 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: 某个应用的黑名单、白名单或自定义名单。 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: >- 名单标识符。在名单和条目 endpoint 中用作 `list_uuid`，并在带有 `value_type: "list"` 的工作流或交易规则条件中用作值。 name: type: string maxLength: 255 description: 名单名称，在应用的各个名单中具有唯一性。 description: type: string description: 自由文本描述。未设置时为空字符串。 list_type: type: string enum: - blocklist - allowlist - custom description: >- `blocklist`：匹配会拒绝会话或交易（仅限系统名单，每种条目类型一个）。`allowlist`：匹配的项目受信任，例如人脸白名单会跳过重复人脸操作；绝不会覆盖黑名单匹配。`custom`：用于工作流和交易规则条件（`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: >- 该名单包含的内容：`face`、`document`（证件号码）、`phone`、`email`、`ip_address`（地址或 CIDR 范围）、`device_fingerprint`、`wallet_address`、`bank_account`、`country`（ISO 3166-1 alpha-3）、`user` 或 `business`（您的 `vendor_data`），或 `key`（任意字符串）。它决定了条目值的验证和匹配方式。 is_system: type: boolean description: >- `true` 表示由 Didit 预配的名单：每种条目类型一个黑名单（`face`、`document`、`phone`、`email`、`ip_address`、`device_fingerprint`、`wallet_address`、`bank_account`、`user`、`business`）、**High Risk Countries** 自定义名单以及系统白名单。系统名单无法重命名、编辑或删除；您可以添加和删除其中的条目。 entry_count: type: integer minimum: 0 description: 当前列表中条目的数量。 last_entry_added_at: type: string format: date-time nullable: true description: 添加最新当前条目的时间。名单为空时为 `null`。 created_at: type: string format: date-time description: 名单创建时间。 updated_at: type: string format: date-time description: 名单最后更新时间。 responses: RateLimitedWrite: description: 已超出每个 API 密钥每分钟 300 次请求的共享写入限制。在重试之前请遵循 `Retry-After`。 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: >- 您的应用 API 密钥，可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域：针对每个资源设为无权限、只读或读写，限定于特定工作流或已通过的会话、限定于 IP 地址列表，以及设置到期日期。401 表示密钥错误、已撤销或已过期；403 表示未发送密钥、密钥无权访问该资源或操作，或请求来自其 IP 列表之外的地址；在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null；没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.