> ## 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：供应商 KYB 实体 > 通过 Didit 获取应用下的全部企业（KYB）实体，可按状态、国家/地区、搜索词和日期筛选。以编程方式管理 KYB 全生命周期。 列出企业提示词 将提示词复制到剪贴板 \

\`Goal: Page through Didit Business (KYB) entities for an application and consume them in your backend.

Endpoint: GET https://verification.didit.me/v3/businesses/
Auth header: x-api-key: 

Query params (all optional):
\- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorBusinessStatusChoices, NOT the session enum).
\- search: free-text over vendor_data, display_name, legal_name, registration_number.
\- country: country of incorporation, ISO 3166-1 alpha-2 (e.g. "GB", "US").
\- limit: integer, 1–200, default 50.
\- offset: integer, 0+, default 0. Prefer following the "next" URL from the previous page.

curl:
curl -X GET 'https://verification.didit.me/v3/businesses/?limit=50&status=ACTIVE' \
-H 'x-api-key: YOUR_API_KEY'

Response 200 (envelope):
\{
"count": ,
"next": ,
"previous": ,
"results": [ BusinessListItem, ... ]
}

BusinessListItem key fields: didit_internal_id (UUID), vendor_data (string, may be null), display_name, legal_name, registration_number, country_code, effective_name, status, session_count, approved_count, declined_count, in_review_count, features (map: KYB_REGISTRY, KYB_AML, KYB_DOCUMENTS, ... -> latest status), features_list, last_session_at, first_session_at, last_activity_at, tags, created_at. See /reference/data-models for the full shape.

Notes:
\- Ordered by last_session_at desc.
\- Deleted businesses are not returned.
\- vendor_data is a free-form client-supplied string, NOT a UUID; may be null when the originating session didn't provide one.

Pagination loop:
url = 'https://verification.didit.me/v3/businesses/?limit=200&status=FLAGGED'
while url:
r = requests.get(url, headers={'x-api-key': API_KEY})
r.raise_for_status()
page = r.json()
for biz in page['results']:
    ...
url = page['next']

Failure modes (envelope {"detail": "..."}):
\- 401 — missing/invalid x-api-key.
\- 403 — key lacks list:businesses.
\- 429 — rate-limited.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\
粘贴到 ## 概述返回已通过身份验证的应用的[企业实体](https://docs.didit.me/zh/entities/businesses/overview.md)分页列表。## 适用场景- **同步**您的企业数据表至外部 BI 或数据仓库。 - **分析师队列**：按 `status=FLAGGED` 筛选，以驱动审核待办列表。 - 按 `display_name`、`legal_name`、`registration_number` 或 `vendor_data` 进行**搜索**。## 筛选与分页| 查询参数 | 说明 | | - | - | | `status` | `ACTIVE`、`FLAGGED` 或 `BLOCKED`。 | | `search` | 对显示名称、法定名称、注册号和 vendor\_data 进行子字符串匹配。 | | `country_code` | 注册国家/地区的 ISO 3166-1 alpha-3 代码。 | | `created_after`、`created_before` | 创建日期范围。 | | `last_activity_after`、`last_activity_before` | 活动时间范围。 | | `page_size` | 1–200。默认值为 50。 | | `cursor` | 分页游标。 |## 注意事项- 如果来源会话或交易未提供 `vendor_data`，则其值可能为 `null`。 - 基于游标的分页：两次调用之间需保存 `next` 游标。 - 每个字段的说明请参见[企业数据模型](https://docs.didit.me/zh/entities/businesses/data-model.md)。## 权限角色必须授予 `list:businesses` 权限。## 相关内容- [企业概览](https://docs.didit.me/zh/entities/businesses/overview.md) - [获取企业](https://docs.didit.me/zh/management-api/businesses/get.md) - [企业操作](https://docs.didit.me/zh/entities/businesses/operations.md) ## OpenAPI ````yaml zh/openapi-25.json GET /v3/businesses/ 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/businesses/: get: tags: - Businesses summary: 列出企业 description: >- 列出 Didit 根据共享相同 `vendor_data`（自由格式字符串，非 UUID）的 KYB 会话汇编的[企业](/entities/businesses)，以及通过 API 创建的企业。支持分页，按 `last_session_at` 降序排列。该 endpoint 不支持过滤或搜索参数，请获取分页并在客户端进行过滤。 operationId: list_businesses parameters: - name: limit in: query schema: type: integer default: 50 minimum: 1 maximum: 1000000 description: 页面大小。省略时默认为 50。虽无强制上限，但为降低延迟建议保持较小的页面大小。 - name: offset in: query schema: type: integer maximum: 1000000 minimum: 0 default: 0 description: 要返回的第一条记录的从零开始的偏移量。建议跟随上一页的 `next` URL，而不是手动计算。 responses: '200': description: 分页的企业列表，包含状态、会话计数和功能明细。 content: application/json: schema: type: object properties: count: type: integer description: >- 匹配行数，出于性能考虑，不超过 100 时为精确值，超过 100 时上限为 100。请勿使用它来检测最后一页；应依靠 `next` 为 `null` 进行判断。 next: type: string nullable: true description: 下一页的绝对 URL，最后一页则为 `null`。 previous: type: string nullable: true description: 上一页的绝对 URL，第一页则为 `null`。 results: type: array items: $ref: '#/components/schemas/BusinessListItem' examples: Example: value: count: 1 next: null previous: null results: - didit_internal_id: a1b2c3d4-e5f6-4890-abcd-ef1234567890 vendor_data: company-123 display_name: null legal_name: Acme Trading Ltd registration_number: '12345678' country_code: GB effective_name: Acme Trading Ltd status: ACTIVE session_count: 2 approved_count: 1 declined_count: 0 in_review_count: 1 features: KYB: Approved features_list: - feature: KYB status: Approved last_session_at: '2026-03-15T10:30:00Z' last_activity_at: '2026-03-15T10:30:00Z' first_session_at: '2026-01-10T08:00:00Z' tags: - uuid: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d name: VIP color: '#2567FF' created_at: '2026-01-10T08:00:00Z' '403': description: >- 缺少、无效或已撤销的 API 密钥，或者该密钥无法列出此应用的企业。缺少密钥返回 `403`；错误、已撤销或已过期的密钥返回 `401`。 content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '429': description: 超出速率限制；请退避并在 `Retry-After` 指定的间隔后重试。 content: application/json: examples: Rate limited: value: detail: Request was throttled. Expected available in 30 seconds. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X GET 'https://verification.didit.me/v3/businesses/?limit=50' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() for item in client.businesses.list(): print(item) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); for await (const item of didit.businesses.list()) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Businesses.ListAutoPaging(ctx, didit.BusinessesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" - lang: java label: Java source: |- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); for (var item : client.businesses().list()) { System.out.println(item); } - lang: php label: PHP source: |- businesses->list() as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.businesses.list.auto_paging_each do |item| puts item.to_h end - lang: csharp label: .NET source: |- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); await foreach (var item in await client.Businesses.ListAsync()) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: BusinessListItem: type: object description: 已验证的企业。 properties: didit_internal_id: type: string format: uuid description: Didit 为此企业分配的稳定内部 UUID。 vendor_data: type: string nullable: true description: 您对此企业的唯一标识符（创建会话时传入）。未提供供应商标识符时可为 null。 display_name: type: string nullable: true description: 您设置的自定义显示名称 legal_name: type: string nullable: true description: 来自登记处或手动输入的官方法定名称 registration_number: type: string nullable: true description: 企业注册号或成立号 country_code: type: string nullable: true description: 注册国家/地区（ISO 3166-1 alpha-2，例如 `GB`、`US`）。 effective_name: type: string nullable: true description: 最佳可用名称：如果已设置则为 display_name，否则为 legal_name status: type: string enum: - ACTIVE - FLAGGED - BLOCKED description: >- 企业记录的生命周期状态（并非会话状态）。`ACTIVE` 为默认值，`FLAGGED` 标记为需要人工关注，`BLOCKED` 会阻止该 `vendor_data` 创建新会话。 session_count: type: integer description: 该企业的验证会话总数 approved_count: type: integer description: 已通过的会话数量 declined_count: type: integer description: 已拒绝的会话数量 in_review_count: type: integer description: 审核中的会话数量 features: type: object description: >- 该企业所有 KYB 会话的每项功能汇总状态。目前唯一的键为 `KYB`（公司登记核验状态）。可选值：`Approved`、`Declined`、`In Review`、`Not Finished`、`Resub Requested`。 features_list: type: array items: type: object properties: feature: type: string status: type: string description: 与 `features` 相同的数据，为 `{feature, status}` 对象的有序数组。 last_session_at: type: string format: date-time nullable: true description: 最近一次会话的时间戳 first_session_at: type: string format: date-time nullable: true description: 首次会话的时间戳 last_activity_at: type: string format: date-time nullable: true description: 最近一次活动的时间戳（状态变更、会话更新等） tags: type: array items: type: object properties: uuid: type: string format: uuid name: type: string color: type: string description: 分配给该企业的标签 created_at: type: string format: date-time 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.