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

# व्यवसाय संचालन: Vendor KYB CRUD

> Didit Management API से व्यवसाय (KYB) एंटिटी का पूरा CRUD: बनाएँ, देखें, अपडेट करें, स्थिति बदलें, हटाएँ। प्रति कॉल भुगतान।



व्यवसाय संचालन प्रॉम्प्ट
        प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें



      
      

\<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/` के अंतर्गत छह सार्वजनिक endpoints के ज़रिए सभी व्यवसाय इकाइयों का प्रबंधन होता है। यह पेज आपको अवधारणात्मक मार्गदर्शन देता है। पूरे अनुरोध और रिस्पॉन्स स्कीमा के लिए [API reference](https://docs.didit.me/hi/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 में शामिल नहीं हैं और व्यवसाय से उनका लिंक हटाकर बने रहते हैं। उन्हें [Delete Session](https://docs.didit.me/hi/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/*` endpoints `businesses` अनुमति संसाधन के दायरे में हैं:| भूमिका | list | get | create | update | update-status | delete |
| - | :-: | :-: | :-: | :-: | :-: | :-: |
| OWNER | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| ADMIN | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| COMPLIANCE\_OFFICER | ✅ | ✅ | ❌ | ✅ | ✅ | ❌ |
| DEVELOPER | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
| READER | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |[भूमिकाएँ और अनुमतियाँ](https://docs.didit.me/hi/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/hi/entities/businesses/data-model.md)
>
> फ़ील्ड का पूरा संदर्भ।> [card] [सूची API](https://docs.didit.me/hi/management-api/businesses/list.md)
>
> GET /v3/businesses/ स्कीमा।> [card] [निर्माण API](https://docs.didit.me/hi/management-api/businesses/create.md)
>
> POST /v3/businesses/create/ स्कीमा।


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