> ## 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) عبر API

> عمليات CRUD كاملة لكيانات Didit للشركات (KYB) عبر Management API: إنشاء وعرض وتحديث وتغيير الحالة وحذف. الدفع لكل استدعاء.



موجّه عمليات الشركات
        نسخ الموجّه إلى الحافظة



      
      

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



      
      

الصق في

تتم إدارة جميع كيانات الشركات عبر ستة endpoint عامة ضمن `/v3/businesses/`. تقدّم لك هذه الصفحة شرحاً مفاهيمياً، وللاطلاع على مخططات الطلب والاستجابة كاملةً راجع [مرجع API](https://docs.didit.me/ar/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/ar/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"] }'
```تتسم هذه العملية بخاصية idempotency، فحذف شركة محذوفة مسبقاً لا يُحدث أي تغيير.## نموذج الأذوناتتخضع جميع endpoints `/v3/businesses/*` لنطاق إذن المورد `businesses`:| الدور | list | get | create | update | update-status | delete |
| - | :-: | :-: | :-: | :-: | :-: | :-: |
| OWNER | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| ADMIN | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| COMPLIANCE\_OFFICER | ✅ | ✅ | ❌ | ✅ | ✅ | ❌ |
| DEVELOPER | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
| READER | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |راجع [الأدوار والأذونات](https://docs.didit.me/ar/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/ar/entities/businesses/data-model.md)
>
> مرجع كامل للحقول.> [card] [API القائمة](https://docs.didit.me/ar/management-api/businesses/list.md)
>
> مخطط GET /v3/businesses/.> [card] [API الإنشاء](https://docs.didit.me/ar/management-api/businesses/create.md)
>
> مخطط POST /v3/businesses/create/.


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