> ## 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：ベンダーのUserエンティティを取得 > Didit APIで、アプリケーションのベンダーUserエンティティをすべて取得できます。ステータス、検索、日付でフィルターし、ユーザーのライフサイクルをプログラムで管理できます。 ユーザー一覧取得プロンプト プロンプトをクリップボードにコピー \

\`Goal: Page through Didit User entities for an application and consume them in your backend.

Endpoint: GET https://verification.didit.me/v3/users/
Auth header: x-api-key: 

Query params (all optional):
\- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices, NOT the session enum).
\- search: free-text over vendor_data, display_name, full_name, approved_emails, approved_phones.
\- country: ISO 3166-1 alpha-3 (e.g. "USA", "ESP") — filters by issuing country of approved documents.
\- 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/users/?limit=50&status=ACTIVE' \
-H 'x-api-key: YOUR_API_KEY'

Response 200 (envelope):
\{
"count": ,
"next": ,
"previous": ,
"results": [ UserListItem, ... ]
}

UserListItem key fields: didit_internal_id (UUID), vendor_data (string, may be null), display_name, full_name, effective_name, status, portrait_image_url, session_count, approved_count, declined_count, in_review_count, issuing_states, approved_emails, approved_phones, features (map of feature -> "Approved" | "Declined" | "In Review" | ...), features_list, last_session_at, first_session_at, tags, created_at. See /reference/data-models for the full shape.

Notes:
\- Ordered by last_session_at desc (most recently active first).
\- Deleted users are not returned.
\- vendor_data is a free-form client-supplied string, NOT a UUID. It may be null when the originating session did not provide one.

Pagination loop:
url = 'https://verification.didit.me/v3/users/?limit=200&status=ACTIVE'
while url:
r = requests.get(url, headers={'x-api-key': API_KEY})
r.raise_for_status()
page = r.json()
for user in page['results']:
    ...handle user...
url = page['next']

Failure modes (all return {"detail": "..."} unless noted):
\- 401 — missing or revoked x-api-key.
\- 403 — the API key is revoked or is not valid for this application.
\- 429 — rate-limited. Honour Retry-After header.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\
貼り付け先 ## 概要認証済みアプリケーションの[ユーザーエンティティ](https://docs.didit.me/ja/entities/users/overview.md)をページネーションされた一覧で返します。ユーザーをデータウェアハウスに同期する、アナリストの対応が必要なユーザーを見つける、表示名で検索する、といった用途に使用します。## 使用する場面- 外部のBIツールやデータウェアハウスへのユーザーテーブルの**定期同期**。 - **アナリスト用キュー**: `status=FLAGGED`や古い`last_activity_at`の値でフィルターし、レビュー用の受信トレイに振り分けます。 - `display_name`、`full_name`、`vendor_data`によるユーザーの**検索**。## フィルターとページネーション| クエリパラメーター | 説明 | | - | - | | `status` | `ACTIVE`、`FLAGGED`、`BLOCKED`でフィルターします。 | | `search` | `vendor_data`、`display_name`、`full_name`、メールアドレス、電話番号に対する部分一致検索です。 | | `country_code` | `issuing_states`(ISO 3166-1 alpha-3)でフィルターします。 | | `created_after`, `created_before` | 作成日の期間(ISO 8601)です。 | | `last_activity_after`, `last_activity_before` | アクティビティの期間です。 | | `page_size` | 1～200。デフォルト: 50。 | | `cursor` | 前回のレスポンスで返されたページネーションカーソルです。 |## 注意事項- 各レスポンス項目には`didit_internal_id`が含まれます。元のセッションまたは取引で指定されなかった場合、`vendor_data`は`null`になることがあります。 - このエンドポイントではカーソルベースのページネーションを使用します。呼び出し間で`next`カーソルを保持し、`next`が空になったら停止してください。 - ユーザーレコードのすべてのフィールドについては、[ユーザーデータモデル](https://docs.didit.me/ja/entities/users/data-model.md)を参照してください。## 権限アプリケーションの有効なAPIキーであれば、どれでもこのエンドポイントを呼び出せます。DiditのAPIキーは **役割単位ではなく、アプリケーション単位**です。Consoleの[役割と権限](https://docs.didit.me/ja/console/roles-permissions.md) (`list:users`など)は、Consoleで*人*が何をできるかを決めるものであり、Management APIのトラフィックに対しては 評価されません。このエンドポイントを呼び出せる人を制御するには、アプリケーションのAPIキーを 読み取れる人を制御してください。## 関連項目- [ユーザーの概要](https://docs.didit.me/ja/entities/users/overview.md) - [ユーザーの取得](https://docs.didit.me/ja/management-api/users/get.md) - [ユーザー操作](https://docs.didit.me/ja/entities/users/operations.md) ## OpenAPI ````yaml ja/openapi-25.json GET /v3/users/ 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/users/: get: tags: - Users summary: ユーザーを一覧表示 description: >- 同じ`vendor_data`(自由形式の文字列で、UUIDではありません)を共有するKYCセッションからDiditがまとめた[ユーザー](/entities/users)と、API経由で作成されたユーザーの一覧を取得します。ページネーションに対応し、`last_session_at`の降順で並びます。このエンドポイントはフィルターや検索のパラメーターに対応していないため、ページを取得してクライアント側でフィルタリングしてください。 operationId: list_users 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/UserListItem' examples: Example: value: count: 2 next: null previous: null results: - didit_internal_id: f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418 vendor_data: user-abc-123 display_name: null full_name: John Michael Doe date_of_birth: '1990-05-15' effective_name: John Michael Doe status: ACTIVE portrait_image_url: https:///... session_count: 3 approved_count: 2 declined_count: 0 in_review_count: 1 issuing_states: - USA approved_emails: - john@example.com approved_phones: - '+14155551234' features: ID_VERIFICATION: Approved LIVENESS: Approved FACE_MATCH: Approved AML: Approved features_list: - feature: ID_VERIFICATION status: Approved - feature: LIVENESS status: Approved - feature: FACE_MATCH status: Approved - feature: AML status: Approved last_session_at: '2025-06-15T10:30:00Z' last_activity_at: '2025-06-15T10:30:00Z' first_session_at: '2025-06-01T08:00:00Z' tags: - uuid: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d name: VIP color: '#2567FF' created_at: '2025-06-01T08:00:00Z' - didit_internal_id: 6ed99d53-e8f5-4cf8-9ac1-4a506cb40f6b vendor_data: null display_name: Jane S. full_name: Jane Elizabeth Smith date_of_birth: '1985-11-22' effective_name: Jane S. status: FLAGGED portrait_image_url: null session_count: 1 approved_count: 0 declined_count: 0 in_review_count: 1 issuing_states: [] approved_emails: [] approved_phones: [] features: ID_VERIFICATION: In Review features_list: - feature: ID_VERIFICATION status: In Review last_session_at: '2025-06-20T14:00:00Z' last_activity_at: '2025-06-20T14:05:00Z' first_session_at: '2025-06-20T14:00:00Z' tags: [] created_at: '2025-06-20T14:00:00Z' '401': description: >- 認証情報が指定されていません。`x-api-key`ヘッダー（または`Authorization: Bearer`トークン）なしの`/v3/users/*`パスへのリクエストは、APIに到達する前に認証ミドルウェアによって拒否されます。 content: application/json: examples: Missing credentials: value: detail: >- You must be authenticated with a valid access token to access this endpoint. '403': description: >- このキーではこのアプリケーションのユーザーを一覧取得できません。キーがない場合は`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/users/?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.users.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.users.list()) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Users.ListAutoPaging(ctx, didit.UsersListParams{})\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.users().list()) { System.out.println(item); } - lang: php label: PHP source: |- users->list() as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.users.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.Users.ListAsync()) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: UserListItem: 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: お客様が設定したカスタム表示名 full_name: type: string nullable: true description: 認証済みの書類から抽出された氏名 date_of_birth: type: string format: date nullable: true effective_name: type: string nullable: true description: 利用可能な最適な名前：display_nameが設定されていればそれを、設定されていなければfull_nameを使用 status: type: string enum: - ACTIVE - FLAGGED - BLOCKED description: >- ユーザーレコードのライフサイクルステータス（セッションのステータスではありません）。`ACTIVE`がデフォルトで、`FLAGGED`はユーザーを手動での確認対象としてマークし、`BLOCKED`はこの`vendor_data`での新規セッションを禁止します。 portrait_image_url: type: string nullable: true description: ユーザーの顔写真の署名付きURL（数時間後に期限切れ） session_count: type: integer description: このユーザーの認証セッションの総数 approved_count: type: integer description: 承認済みセッションの数 declined_count: type: integer description: 却下されたセッションの数 in_review_count: type: integer description: レビュー中のセッション数 issuing_states: type: array items: type: string description: >- このユーザーの承認済み身分証明書類で確認された発行国のISO 3166-1 alpha-3コード。例: `["USA", "ESP"]`。該当がない場合は空の配列です。 approved_emails: type: array items: type: string description: 'このユーザーの承認済みセッションから収集された認証済みメールアドレス。例: `["john@example.com"]`。' approved_phones: type: array items: type: string description: 'このユーザーの承認済みセッションから収集された認証済み電話番号。例: `["+14155551234"]`。' features: type: object description: >- このユーザーのすべてのセッションを通じた、機能ごとの集計ステータスです。取り得るキーは`ID_VERIFICATION`、`NFC`、`LIVENESS`、`FACE_MATCH`、`POA`、`QUESTIONNAIRE`、`EMAIL_VERIFICATION`、`PHONE`、`AML`、`IP_ANALYSIS`、`AGE_ESTIMATION`、`DATABASE_VALIDATION`です。取り得る値は`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.