> ## 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/ja/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/ja/entities/businesses/data-model.md)を参照してください。## 権限役割に`list:businesses`が付与されている必要があります。## 関連情報- [企業の概要](https://docs.didit.me/ja/entities/businesses/overview.md)
- [企業の取得](https://docs.didit.me/ja/management-api/businesses/get.md)
- [企業に対する操作](https://docs.didit.me/ja/entities/businesses/operations.md)


## OpenAPI

````yaml ja/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`の降順で並びます。このエンドポイントはフィルターや検索のパラメーターに対応していないため、ページを取得してクライアント側でフィルタリングしてください。
      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: 返す最初のレコードの0始まりのオフセットです。手動で計算するよりも、前のページの`next`URLをたどる方法を推奨します。
      responses:
        '200':
          description: ステータス、セッション数、機能別の内訳を含む、ページネーションされた企業一覧。
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: >-
                      一致する行の数。100までは正確な値で、パフォーマンスのため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で取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください:
        https://docs.didit.me/console/api-keys

````

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