> ## 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 जीवनचक्र।



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



      
      

\<pre>

\`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: <DIDIT_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": <int — exact up to 100, capped above; pagination still works via "next">,
"next": <URL or null>,
"previous": <URL or null>,
"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.`

\</pre>



      
      

यहाँ पेस्ट करें

## अवलोकनप्रमाणित एप्लिकेशन के लिए [व्यवसाय इकाइयाँ](https://docs.didit.me/hi/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/hi/entities/businesses/data-model.md) देखें।## अनुमतियाँभूमिका के पास `list:businesses` की अनुमति होनी चाहिए।## संबंधित- [व्यवसाय अवलोकन](https://docs.didit.me/hi/entities/businesses/overview.md)
- [व्यवसाय प्राप्त करें](https://docs.didit.me/hi/management-api/businesses/get.md)
- [व्यवसाय संचालन](https://docs.didit.me/hi/entities/businesses/operations.md)


## OpenAPI

````yaml hi/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: >-
        समान `vendor_data` (फ़्री-फ़ॉर्म स्ट्रिंग, UUID नहीं) साझा करने वाले KYB
        सत्रों से Didit द्वारा एकत्रित [व्यवसायों](/entities/businesses) के
        साथ-साथ API के माध्यम से बनाए गए व्यवसायों को सूचीबद्ध करें। पेजिनेटेड,
        `last_session_at` desc द्वारा क्रमित। यह 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 पर सीमित। अंतिम पेज का पता
                      लगाने के लिए इसका उपयोग न करें; इसके बजाय `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: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            foreach ($didit->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 में Developers -> API keys
        से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप
        किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या
        स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक
        सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी
        समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी,
        कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP
        सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी
        के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को
        छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write
        के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं।
        देखें https://docs.didit.me/console/api-keys।

````

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