> ## 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 Daftar Bisnis: Entitas KYB Vendor

> Ambil semua entitas Bisnis (KYB) Didit untuk aplikasi Anda dengan filter status, negara, pencarian, dan tanggal. Siklus hidup KYB secara terprogram.



Prompt Daftar Bisnis
        Salin prompt ke papan klip



      
      

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



      
      

Tempel ke

## IkhtisarMengembalikan daftar [entitas bisnis](https://docs.didit.me/id/entities/businesses/overview.md) yang dipaginasi untuk aplikasi yang terautentikasi.## Kapan digunakan- **Sinkronkan** tabel bisnis Anda ke BI eksternal atau gudang data.
- **Antrean analis**: filter dengan `status=FLAGGED` untuk mengisi kotak masuk peninjauan.
- **Cari** berdasarkan `display_name`, `legal_name`, `registration_number`, atau `vendor_data`.## Filter dan paginasi| Parameter query | Deskripsi |
| - | - |
| `status` | `ACTIVE`, `FLAGGED`, atau `BLOCKED`. |
| `search` | Pencocokan substring pada nama tampilan, nama hukum, nomor registrasi, vendor\_data. |
| `country_code` | Kode negara ISO 3166-1 alpha-3 negara tempat pendirian. |
| `created_after`, `created_before` | Rentang tanggal pembuatan. |
| `last_activity_after`, `last_activity_before` | Rentang aktivitas. |
| `page_size` | 1–200. Nilai default 50. |
| `cursor` | Kursor paginasi. |## Catatan- `vendor_data` dapat bernilai `null` jika sesi atau transaksi asal tidak menyediakannya.
- Paginasi berbasis cursor: simpan kursor `next` di antara panggilan.
- Lihat [model data bisnis](https://docs.didit.me/id/entities/businesses/data-model.md) untuk setiap kolom.## IzinPeran harus memberikan izin `list:businesses`.## Terkait- [Ikhtisar bisnis](https://docs.didit.me/id/entities/businesses/overview.md)
- [Ambil bisnis](https://docs.didit.me/id/management-api/businesses/get.md)
- [Operasi bisnis](https://docs.didit.me/id/entities/businesses/operations.md)


## OpenAPI

````yaml id/openapi-25.json GET /v3/businesses/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API Verifikasi Identitas. Lakukan autentikasi dengan header x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/businesses/:
    get:
      tags:
        - Businesses
      summary: Daftar bisnis
      description: >-
        Daftar [bisnis](/entities/businesses) yang dikumpulkan Didit dari sesi
        KYB yang berbagi `vendor_data` yang sama (string format bebas, BUKAN
        UUID), beserta bisnis yang dibuat melalui API. Dipaginasi, diurutkan
        berdasarkan `last_session_at` menurun. Endpoint ini tidak mendukung
        parameter pemfilteran atau pencarian — ambil halaman dan filter di sisi
        klien.
      operationId: list_businesses
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
          description: >-
            Ukuran halaman. Nilai default-nya 50 jika dihilangkan. Tidak ada
            batasan maksimum yang diterapkan, tetapi jaga ukuran halaman tetap
            kecil demi latensi.
        - name: offset
          in: query
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
          description: >-
            Offset berbasis nol dari rekaman pertama yang dikembalikan.
            Sebaiknya ikuti URL `next` dari halaman sebelumnya daripada
            menghitungnya secara manual.
      responses:
        '200':
          description: >-
            Daftar bisnis berpaginasi dengan status, jumlah sesi, dan rincian
            fitur.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: >-
                      Jumlah baris yang cocok — tepat hingga 100, dibatasi pada
                      100 setelahnya demi performa. Jangan gunakan ini untuk
                      mendeteksi halaman terakhir; andalkan `next` yang bernilai
                      `null` sebagai gantinya.
                  next:
                    type: string
                    nullable: true
                    description: >-
                      URL absolut halaman berikutnya, atau `null` di halaman
                      terakhir.
                  previous:
                    type: string
                    nullable: true
                    description: >-
                      URL absolut halaman sebelumnya, atau `null` di halaman
                      pertama.
                  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: >-
            Kunci API tidak ada, tidak valid, atau dicabut, atau kunci tersebut
            tidak dapat menampilkan daftar bisnis untuk aplikasi ini. Kunci yang
            tidak ada mengembalikan `403`; kunci yang salah, dicabut, atau
            kedaluwarsa mengembalikan `401`.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '429':
          description: >-
            Batas laju terlampaui; kurangi laju permintaan dan coba lagi setelah
            interval yang ditunjukkan dalam `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: Bisnis yang terverifikasi.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: UUID internal yang stabil dari Didit untuk bisnis ini.
        vendor_data:
          type: string
          nullable: true
          description: >-
            Pengidentifikasi unik Anda untuk bisnis ini (diteruskan saat membuat
            sesi). Nilai ini dapat berupa null jika tidak ada pengidentifikasi
            vendor yang diberikan.
        display_name:
          type: string
          nullable: true
          description: Nama tampilan kustom yang Anda tetapkan
        legal_name:
          type: string
          nullable: true
          description: Nama resmi menurut hukum dari registri atau entri manual
        registration_number:
          type: string
          nullable: true
          description: Nomor registrasi atau nomor pendirian perusahaan
        country_code:
          type: string
          nullable: true
          description: Negara pendirian (ISO 3166-1 alpha-2, misalnya `GB`, `US`).
        effective_name:
          type: string
          nullable: true
          description: >-
            Nama terbaik yang tersedia: display_name jika disetel, selain itu
            legal_name
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Status siklus hidup rekaman bisnis (BUKAN status sesi). `ACTIVE`
            adalah default, `FLAGGED` menandainya untuk perhatian manual,
            `BLOCKED` mencegah sesi baru untuk `vendor_data` ini.
        session_count:
          type: integer
          description: Jumlah total sesi verifikasi untuk bisnis ini
        approved_count:
          type: integer
          description: Jumlah sesi yang disetujui
        declined_count:
          type: integer
          description: Jumlah sesi yang ditolak
        in_review_count:
          type: integer
          description: Jumlah sesi dalam peninjauan
        features:
          type: object
          description: >-
            Status per-fitur agregat di semua sesi KYB bisnis ini. Saat ini
            satu-satunya kunci adalah `KYB` (status pemeriksaan perusahaan di
            registri). Nilai yang memungkinkan: `Approved`, `Declined`, `In
            Review`, `Not Finished`, `Resub Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Data yang sama dengan `features`, sebagai array berurutan dari objek
            `{feature, status}`.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Cap waktu sesi terbaru
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Cap waktu sesi pertama
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: Cap waktu aktivitas terbaru (perubahan status, pembaruan sesi, dll.)
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Tag yang ditetapkan untuk bisnis ini
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Kunci API aplikasi Anda, dari Developers -> API keys di Business
        Console. Kunci utama memiliki akses penuh. Kunci bernama dapat diberi
        cakupan: none, read, atau write per sumber daya, dibatasi pada beberapa
        alur kerja atau pada sesi yang disetujui, pada daftar alamat IP, dan
        pada tanggal kedaluwarsa. 401 berarti kuncinya salah, dicabut, atau
        kedaluwarsa; 403 berarti tidak ada kunci yang dikirimkan, kunci tidak
        memiliki akses ke sumber daya atau tindakan ini, atau permintaan datang
        dari alamat di luar daftar IP-nya; 404 pada rute sesi berarti sesi
        berada di luar alur kerja atau status kunci tersebut. Kunci tanpa akses
        media menerima URL gambar, video, dan PDF sebagai null, dan kunci tanpa
        izin tulis sesi menerima tautan sesi dan token sebagai null. Lihat
        https://docs.didit.me/console/api-keys.

````

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