> ## 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操作:作成・一覧・更新・削除

> DiditのManagement APIで、企業(KYB)エンティティを作成・一覧取得・取得・更新・ステータス変更・削除できます。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/`配下にある6つの公開エンドポイントを通じて行います。このページでは概念的な概要を説明します。リクエストとレスポンスの完全なスキーマについては[APIリファレンス](https://docs.didit.me/ja/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`を指定して1件の企業を取得します。```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` | 自動ブロックを伴う法人確認 (KYB)セッションの`Declined`、制裁対象エンティティであることの確定 |
| `FLAGGED` → `ACTIVE` | アナリストがレビューで問題なしと判断 |
| `BLOCKED` → `ACTIVE` | 是正後の手動によるブロック解除 |`business.status.updated`を発行します。## 企業の削除 (一括)**`POST /v3/businesses/delete/`**1件以上の企業を削除します。企業レコードは完全に削除されます。このエンドポイントは検証セッションを対象としないため、セッションは企業との紐付けが解除された状態で残ります。セッションは[Delete Session](https://docs.didit.me/ja/sessions-api/delete-session.md)で削除してください。取引も対象外です。取引はConsoleから削除してください。```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/*`のすべてのエンドポイントへのアクセスは、`businesses`権限リソースによって制御されます：| 役割 | list | get | create | update | update-status | delete |
| - | :-: | :-: | :-: | :-: | :-: | :-: |
| OWNER | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| ADMIN | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| COMPLIANCE\_OFFICER | ✅ | ✅ | ❌ | ✅ | ✅ | ❌ |
| DEVELOPER | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
| READER | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |[役割と権限](https://docs.didit.me/ja/console/roles-permissions.md)を参照してください。## これらの操作で送信されるWebhook| 操作 | Webhook |
| - | - |
| `create` | `business.data.updated` |
| `update` | `changed_fields`を含む`business.data.updated` |
| `update-status` | `business.status.updated` |
| `delete` | `deleted_at`が設定された`business.data.updated` |## 次のステップ> [card] [データモデル](https://docs.didit.me/ja/entities/businesses/data-model.md)
>
> 全フィールドのリファレンス。> [card] [一覧取得API](https://docs.didit.me/ja/management-api/businesses/list.md)
>
> GET /v3/businesses/のスキーマ。> [card] [作成API](https://docs.didit.me/ja/management-api/businesses/create.md)
>
> POST /v3/businesses/create/のスキーマ。


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