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

# 企业运营：供应商 KYB 企业 CRUD

> 通过管理 API 对 Didit 企业（KYB）实体进行完整的 CRUD 操作，包括创建、列出、获取、更新、变更状态和删除。按次计费的 KYB。



企业操作提示词
        将提示词复制到剪贴板



      
      

\<pre>

\````# Goal — full CRUD over Didit Business (KYB) entities

All operations sit under `https://verification.didit.me/v3/businesses/` authenticated with `x-api-key: $DIDIT_API_KEY`. Each Business is keyed by `vendor_data` (case-sensitive, unique per application).

\## Endpoint catalog

\| Action | Method + path |
\|---|---|
\| List businesses | `GET /v3/businesses/` |
\| Get one business | `GET /v3/businesses/{vendor_data}/` |
\| Create business | `POST /v3/businesses/create/` |
\| Update profile | `PATCH /v3/businesses/{vendor_data}/` |
\| Change status | `PATCH /v3/businesses/{vendor_data}/update-status/` |
\| Batch delete | `POST /v3/businesses/delete/` |

\## List (with filters)

\```bash
curl -G https://verification.didit.me/v3/businesses/ \
-H "x-api-key: $DIDIT_API_KEY" \
\--data-urlencode "status=ACTIVE" \
\--data-urlencode "country_code=GBR" \
\--data-urlencode "page_size=50"
\```

\## Get one business

\```bash
curl https://verification.didit.me/v3/businesses/biz-acme/ \
-H "x-api-key: $DIDIT_API_KEY"
\```

\## Create

\```bash
curl -X POST https://verification.didit.me/v3/businesses/create/ \
-H "x-api-key: $DIDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"vendor_data": "biz-acme",
"display_name": "Acme Corp",
"country_code": "GBR",
"metadata": {"partner": "Acme Holdings"}
}'
\```

Not idempotent — a duplicate `vendor_data` returns conflict. `GET` first or PATCH.

\## Update profile

\```bash
curl -X PATCH https://verification.didit.me/v3/businesses/biz-acme/ \
-H "x-api-key: $DIDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"metadata": {"tier": "enterprise"}}'
\```

Mutable: `display_name`, `metadata`, `tags`. Read-only (registry-derived after a KYB session): `legal_name`, `registration_number`, `country_code`, all aggregate counters, `features` map.

\## Change status

\```bash
curl -X PATCH https://verification.didit.me/v3/businesses/biz-acme/update-status/ \
-H "x-api-key: $DIDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"status": "BLOCKED", "reason": "Sanctioned subsidiary detected"}'
\```

Valid statuses: `ACTIVE`, `FLAGGED`, `BLOCKED`. `BLOCKED` businesses have new KYB sessions and transactions auto-declined.

\## Batch delete

\```bash
curl -X POST https://verification.didit.me/v3/businesses/delete/ \
-H "x-api-key: $DIDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"vendor_data": ["biz-acme", "biz-alpha", "biz-beta"]}'
\```

Idempotent. The business records are removed permanently. Verification sessions are not covered by this endpoint; delete those with the session delete endpoints.

\## Webhooks fired

\| Operation | Event |
\|---|---|
\| create | `business.data.updated` |
\| update (PATCH) | `business.data.updated` with `changed_fields` |
\| update-status | `business.status.updated` |
\| delete | `business.data.updated` with `deleted_at` set |

\## Running a KYB session against an existing Business

KYB sessions use the same `POST /v3/session/` endpoint as KYC — the workflow's `workflow_type: "kyb"` switches the session into business mode:

\```bash
curl -X POST https://verification.didit.me/v3/session/ \
-H "x-api-key: $DIDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"workflow_id": "$KYB_WORKFLOW_ID", "vendor_data": "biz-acme"}'
\```

\## Failure modes

\- `401` — missing / invalid `x-api-key`.
\- `403` — role lacks the permission (DEVELOPER can't PATCH; see /console/roles-permissions).
\- `409` on create — `vendor_data` exists; PATCH instead.
\- `404` — wrong `vendor_data` casing.
\- `429` — rate-limited; back off with `Retry-After`.

\## Response shape

See /reference/data-models and /entities/businesses/data-model for the full Business schema.

\## Sources of truth

\- /management-api/businesses/list, /management-api/businesses/get, /management-api/businesses/create — per-endpoint reference
\- /entities/businesses/data-model — field-by-field
\- /business-verification/integration-guide — KYB session flow
\- /integration/integration-prompt — canonical end-to-end prompt````

\</pre>



      
      

粘贴到

企业实体的所有管理操作都通过 `/v3/businesses/` 下的六个公开 endpoint 完成。本页介绍概念性流程；完整的请求与响应架构，请参阅 [API 参考](https://docs.didit.me/zh/management-api/businesses/list.md)。## 列出企业**`GET /v3/businesses/`**为您的应用返回分页的企业列表，可按状态、搜索关键词、国家/地区和日期范围进行筛选。```bash theme={null}
curl -G https://verification.didit.me/v3/businesses/ \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "status=ACTIVE" \
  --data-urlencode "country_code=GBR" \
  --data-urlencode "page_size=50"
```## 获取企业**`GET /v3/businesses/{vendor_data}/`**通过 `vendor_data` 获取单个企业。```bash theme={null}
curl https://verification.didit.me/v3/businesses/biz-acme/ \
  -H "x-api-key: YOUR_API_KEY"
```## 创建企业**`POST /v3/businesses/create/`**在企业验证（KYB）会话运行之前，预先创建企业：```bash theme={null}
curl -X POST https://verification.didit.me/v3/businesses/create/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_data": "biz-acme",
    "display_name": "Acme Corp",
    "country_code": "GBR",
    "metadata": { "partner": "Acme Holdings" }
  }'
```如果 `vendor_data` 相同的企业已存在，则返回冲突错误。如需更新已有企业，请使用 `PATCH`。## 更新企业**`PATCH /v3/businesses/{vendor_data}/`**更新可变的资料字段。通过登记信息查询得到的字段（`legal_name`、`registration_number`、`country_code`）在验证后为只读，但仍可被覆盖；覆盖操作会在审计日志中标记。**可变字段：**`display_name`、`metadata`、`tags`。
**验证后只读：**所有源自登记信息的字段、汇总计数器以及 `features` 映射。```bash theme={null}
curl -X PATCH https://verification.didit.me/v3/businesses/biz-acme/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "metadata": { "tier": "enterprise" } }'
```触发 `business.data.updated`。## 变更状态**`PATCH /v3/businesses/{vendor_data}/update-status/`**在 `ACTIVE`、`FLAGGED` 和 `BLOCKED` 之间切换企业状态。```bash theme={null}
curl -X PATCH https://verification.didit.me/v3/businesses/biz-acme/update-status/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "BLOCKED",
    "reason": "Sanctioned subsidiary detected in ownership chain"
  }'
```| 从 → 到 | 常见触发条件 |
| - | - |
| `ACTIVE` → `FLAGGED` | 企业验证（KYB）会话进入 `In Review`，持续 AML 监控命中，或交易规则触发 |
| `ACTIVE` → `BLOCKED` | 确认为受制裁实体，或手动加入黑名单 |
| `FLAGGED` → `ACTIVE` | 分析师已清除审核标记 |
| `BLOCKED` → `ACTIVE` | 整改后手动解除封禁 |触发 `business.status.updated`。## 批量删除企业**`POST /v3/businesses/delete/`**删除一个或多个企业。企业记录将被永久删除。此 endpoint 不涵盖这些企业的验证会话：会话会保留，但与企业的关联会被清除；如需删除会话，请使用[删除会话](https://docs.didit.me/zh/sessions-api/delete-session.md)。此 endpoint 也不涵盖交易记录；请在控制台中删除这些交易。```bash theme={null}
curl -X POST https://verification.didit.me/v3/businesses/delete/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "vendor_data": ["biz-acme", "biz-alpha", "biz-beta"] }'
```具有幂等性：删除已被删除的企业不产生任何效果。## 权限模型所有 `/v3/businesses/*` endpoint 均受 `businesses` 权限资源的范围限定：| 角色 | 列表 | 获取 | 创建 | 更新 | 更新状态 | 删除 |
| - | :-: | :-: | :-: | :-: | :-: | :-: |
| OWNER | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| ADMIN | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| COMPLIANCE\_OFFICER | ✅ | ✅ | ❌ | ✅ | ✅ | ❌ |
| DEVELOPER | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
| READER | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |参阅[角色与权限](https://docs.didit.me/zh/console/roles-permissions.md)。## 这些操作触发的 Webhook| 操作 | Webhook |
| - | - |
| `create` | `business.data.updated` |
| `update` | `business.data.updated`，并包含 `changed_fields` |
| `update-status` | `business.status.updated` |
| `delete` | `business.data.updated`，并设置 `deleted_at` |## 后续步骤> [card] [数据模型](https://docs.didit.me/zh/entities/businesses/data-model.md)
>
> 完整的字段参考。> [card] [列表 API](https://docs.didit.me/zh/management-api/businesses/list.md)
>
> GET /v3/businesses/ 的架构。> [card] [创建 API](https://docs.didit.me/zh/management-api/businesses/create.md)
>
> POST /v3/businesses/create/ 的架构。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.