> ## 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 > Didit Management APIで認証セッションのイベントタイムラインを取得します。デバイスから報告されたステップ、ステータス変更、ワークフローのルーティングを新しい順にページネーション付きで返します。 セッションイベント一覧API用プロンプト プロンプトをクリップボードにコピー 
  \`Read the event timeline of one Didit verification session through the API.

  Endpoint:
  GET [https://verification.didit.me/v3/session/\{session\_id}/events/](https://verification.didit.me/v3/session/\{session_id}/events/)

  Authentication:
  Send my Didit API key in the x-api-key header. A scoped key needs sessions: read and decisions: read.

  Goal:

  * See what happened during a session, step by step: which screens the user saw, where they stopped, which attempts failed, when the status changed and how the workflow routed the session.

  Behavior:

  * Works for user (KYC) and business (KYB) session IDs.
  * Ordered by sent\_at, newest first. sent\_at is a Unix timestamp in milliseconds.
  * Paginated with limit (default 50) and offset. The response is { count, next, previous, results }. Follow next until it is null.
  * Device-reported event types: LINK\_OPENED, STEP\_RENDERED, BUTTON\_CLICKED, FORM\_SUBMITTED, FILE\_UPLOADED, ATTEMPT\_FAILED, LOG. Server-recorded types include SESSION\_CREATED, SESSION\_STATUS\_CHANGED (details.old\_status, details.current\_status), FEATURE\_STEP\_CHANGED, WORKFLOW\_BRANCH\_EVALUATED and WORKFLOW\_STATUS\_NODE\_REACHED.
  * Events are stored asynchronously, so a new event can take a few seconds to appear.
  * file\_url is a short-lived presigned link; a scoped key without media: read receives it as null.

  Example call:
  curl -X GET "[https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/events/?limit=50](https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/events/?limit=50)" \
  -H "x-api-key: YOUR\_API\_KEY"

  What to read from the response:

  * results\[].event\_type, feature\_step (OCR, LIVENESS, FACE\_MATCH, ...) and step (the screen, for example DOCUMENT\_CAPTURE\_FRONT).
  * results\[].details: event-specific data; the keys vary by event\_type.
  * results\[].ip\_address, user\_agent and device\_info for device-reported events.
  * count, next and previous for pagination.

  Failure modes:

  * 400: limit or offset above 1,000,000.
  * 401: the API key has expired.
  * 403: missing key (a wrong, revoked or expired key gets 401), a key of another application, a scoped key without the permissions above, or a request from outside the key's IP allowlist.
  * 404: the session does not exist, was deleted, or is outside a scoped key's workflow or status limits.

  Side effects: none. This is a pure read.

  For the full integration shape, see /integration/integration-prompt.\`
貼り付け先 ワークフローのルーティングイベント(`WORKFLOW_BRANCH_EVALUATED`、`WORKFLOW_STATUS_NODE_REACHED`)とその`details`については、[セッションの取得](https://docs.didit.me/ja/sessions-api/retrieve-session.md)で説明しています。このエンドポイントでは、`?include=events`を指定すると、ユーザー認証(KYC)セッションのタイムラインを判定内に含めて返すこともできます。 ## OpenAPI ````yaml ja/openapi-25.json GET /v3/session/{sessionId}/events/ 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/session/{sessionId}/events/: get: tags: - Sessions summary: セッションイベントを一覧表示 description: >- 1件の検証セッションのイベントタイムラインを、`sent_at`の新しい順に読み取ります。ユーザーが見た画面、ボタン操作やアップロード、失敗した試行、ステータスおよび機能ステップの変更、ワークフローのルーティングトレースが含まれます。ユーザー認証 (KYC) と法人確認 (KYB) のセッションIDに対応しています。イベントは非同期で保存されるため、新しいイベントが表示されるまで数秒かかる場合があります。結果は`limit`と`offset`でページ分割されます。`next`が`null`になるまでたどってください。スコープ付きAPIキーには`sessions: read`と`decisions: read`が必要です。`media: read`がない場合、`file_url`は`null`で返されます。ルーティングイベントについては[セッションの取得](https://docs.didit.me/ja/sessions-api/retrieve-session)で説明しています。 operationId: get_v3_session_events parameters: - name: sessionId in: path required: true description: >- 検証セッションのUUID(`POST /v3/session/`が返す`session_id`)。ユーザー認証(KYC)と法人確認(KYB)の両方のセッションIDを受け付けます。サーバーは両方のセッションタイプにわたってIDを解決します。正しい形式のUUIDである必要があります。形式が不正な値はルートに一致せず、HTMLの`404`を返します。 schema: type: string format: uuid example: 11111111-2222-3333-4444-555555555555 - name: limit in: query required: false description: >- 1ページあたりの最大イベント数です。デフォルトは50です。1未満の値または数値以外の値は50にフォールバックし、1,000,000を超える値は`400`を返します。 schema: type: integer default: 50 minimum: 1 maximum: 1000000 example: 50 - name: offset in: query required: false description: >- 最初に返す結果の前にスキップする結果の件数です。デフォルトは0です。負の値または数値でない値は0として扱われ、1,000,000を超える値は`400`を返します。`next`と`previous`のURLをたどる方法を推奨します。 schema: type: integer default: 0 minimum: 0 maximum: 1000000 example: 0 - name: ordering in: query required: false description: >- 任意の並べ替え指定です。デフォルトの順序は`-sent_at`です。結果のフィールド名（例：`sent_at`、`created_at`、`event_type`、`feature_step`、`step`）を渡すと昇順に並べ替えられ、先頭に`-`を付けると降順になります。複数のフィールドはカンマで区切ります。不明なフィールドは無視されます。 schema: type: string example: sent_at responses: '200': description: セッションのイベントの1ページ分です。新しい順に並びます。 content: application/json: schema: type: object required: - count - next - previous - results properties: count: type: integer description: セッションのイベントの総数。 next: type: string format: uri nullable: true description: 次のページのURL。最後のページでは`null`です。 previous: type: string format: uri nullable: true description: 前のページのURL。最初のページでは`null`です。 results: type: array items: $ref: '#/components/schemas/SessionEvent' examples: Completed session: value: count: 3 next: null previous: null results: - uuid: aaaaaaaa-1111-2222-3333-444444444444 event_type: SESSION_STATUS_CHANGED created_at: '2026-09-14T10:02:13.904512Z' component: null feature_step: null step: null details: old_status: In Progress current_status: Approved ip_address: null user_agent: null device_info: null file_url: null sent_at: 1789380131482 - uuid: bbbbbbbb-1111-2222-3333-444444444444 event_type: FEATURE_STEP_CHANGED created_at: '2026-09-14T10:01:49.210377Z' component: null feature_step: null step: null details: old_feature_step: OCR current_feature_step: LIVENESS ip_address: null user_agent: null device_info: null file_url: null sent_at: 1789380107103 - uuid: cccccccc-1111-2222-3333-444444444444 event_type: STEP_RENDERED created_at: '2026-09-14T10:01:00.581930Z' component: DocumentCapture feature_step: OCR step: DOCUMENT_CAPTURE_FRONT details: {} ip_address: 203.0.113.24 user_agent: >- Mozilla/5.0 (iPhone; CPU iPhone OS 18_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Mobile/15E148 Safari/604.1 device_info: device_model: iPhone file_url: null sent_at: 1789380058776 '400': description: '`limit`または`offset`が1,000,000を超えています。レスポンス本文はメッセージ1件を含むJSON配列です。' content: application/json: examples: Limit too large: summary: limit=2000000 value: - limit must not exceed 1000000. Offset too large: summary: offset=2000000 value: - offset must not exceed 1000000. schema: type: array items: type: string '401': description: >- スコープ付きAPIキーの有効期限が切れています。`401`が返されるのはこの場合のみです。キーが指定されていない場合、無効な場合、または取り消されている場合は`403`が返されます。 content: application/json: schema: type: object properties: detail: type: string description: 人が読めるエラーメッセージ。 examples: Expired key: summary: キーの有効期限が過ぎています value: detail: This API key has expired. '403': description: >- 認証または認可に失敗しました。キーがない場合、別のアプリケーションのキーの場合、このエンドポイントに必要な権限を持たないスコープ付きキーの場合、キーのIP許可リスト外からのリクエストの場合は`403`を返し、誤った、失効した、または期限切れのキーの場合は`401`を返します。`detail`で区別してください。 content: application/json: schema: type: object properties: detail: type: string description: 人が読めるエラーメッセージ。 examples: Missing or invalid credentials: summary: x-api-keyヘッダーがないか、キーの検証に失敗しました value: detail: >- Authentication credentials were not provided or are invalid. Other application: summary: セッションとは別のアプリケーションに属する有効なキー value: detail: You do not have permission to perform this action. Scoped key without sessions read: summary: 'スコープ付きキーにsessions: read権限がない' value: detail: This API key has no read access to sessions. Scoped key without decisions read: summary: 'スコープ付きキーにdecisions: read権限がない' value: detail: This API key has no read access to decisions. IP not allowed: summary: キーのIP許可リスト外からのリクエスト value: detail: This API key can't be used from this IP address. '404': description: >- セッションが存在しない、削除されている、またはスコープ付きキーのワークフローまたは承認済みのみの制限外です。セッションの照会は認証情報の確認より前に行われるため、有効なキーがなくても、不明な`sessionId`には`404`が返されます。 content: application/json: schema: type: object properties: detail: type: string description: 人が読めるエラーメッセージ。 examples: Unknown session: summary: このIDのセッションが存在しないか、削除されています value: detail: Not found. Outside key limits: summary: セッションがスコープ付きキーのワークフローまたは承認済みのみの制限外です value: detail: Session not found. '429': description: >- レート制限を超過しました。GETリクエストはAPIキーごとに1分あたり600件までです。`Retry-After`秒待ってから再試行してください。`X-RateLimit-*`ヘッダーで利用枠を確認できます。 content: application/json: schema: type: object properties: detail: type: string description: 人が読めるエラーメッセージ。 examples: Rate limited: summary: 現在の1分間の上限を使い切りました value: detail: >- GET request rate limit exceeded. You can make up to 600 requests per minute. headers: Retry-After: description: 再試行までに待機する秒数。 schema: type: integer minimum: 1 example: 30 security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/events/?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.sessions.list_events( "11111111-2222-3333-4444-555555555555", ): 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.sessions.listEvents("11111111-2222-3333-4444-555555555555")) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.ListEventsAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsListEventsParams{})\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.sessions().listEvents("11111111-2222-3333-4444-555555555555")) { System.out.println(item); } - lang: php label: PHP source: >- sessions->listEvents('11111111-2222-3333-4444-555555555555') as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: >- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.sessions.list_events("11111111-2222-3333-4444-555555555555").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.Sessions.ListEventsAsync("11111111-2222-3333-4444-555555555555")) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: SessionEvent: type: object description: 検証セッションのイベントタイムラインのエントリー1件。 required: - uuid - event_type - created_at - component - feature_step - step - details - ip_address - user_agent - device_info - file_url - sent_at properties: uuid: type: string format: uuid description: イベントの識別子です。 event_type: type: string enum: - SESSION_CREATED - SESSION_COMPLETED - SESSION_STATUS_CHANGED - LINK_OPENED - FORM_SUBMITTED - BUTTON_CLICKED - FILE_UPLOADED - ATTEMPT_FAILED - FEATURE_STEP_CHANGED - STEP_RENDERED - NOTE_ADDED - MANUAL_REVIEW_STARTED - WORKFLOW_BRANCH_EVALUATED - WORKFLOW_STATUS_NODE_REACHED - LOG description: >- 発生した内容。ホスト型フローまたはSDKの実行中にデバイスから報告されるもの: `LINK_OPENED`、`STEP_RENDERED`、`BUTTON_CLICKED`、`FORM_SUBMITTED`、`FILE_UPLOADED`、`ATTEMPT_FAILED`、`LOG`（デバッグ用）。サーバーが記録するもの: `SESSION_CREATED`、`SESSION_STATUS_CHANGED`（`details.old_status`、`details.current_status`）、`FEATURE_STEP_CHANGED`（`details.old_feature_step`、`details.current_feature_step`）、`WORKFLOW_BRANCH_EVALUATED`、`WORKFLOW_STATUS_NODE_REACHED`（ワークフローのルーティングトレース）。古いセッションでは`SESSION_COMPLETED`、`NOTE_ADDED`、`MANUAL_REVIEW_STARTED`が表示される場合があります。 created_at: type: string format: date-time description: Diditがイベントを保存した日時です。イベントは非同期で保存されるため、`sent_at`の数秒後になります。 component: type: string nullable: true description: イベントを報告したUIコンポーネント（デバイスイベントのみ）。 feature_step: type: string nullable: true enum: - OCR - OCR_BACK - NFC - AML - FACE - LIVENESS - FACE_MATCH - IP_ANALYSIS - AGE_ESTIMATION - PROOF_OF_ADDRESS - PHONE_VERIFICATION - EMAIL_VERIFICATION - FACE_SEARCH - DATABASE_VALIDATION - QUESTIONNAIRE - KYB_REGISTRY - KYB_DOCUMENTS - KYB_KEY_PEOPLE - DOCUMENT_AI - GEOLOCATION - null description: イベント発生時にセッションが実行していた認証機能。 step: type: string nullable: true description: '機能内の画面(例: `DOCUMENT_CAPTURE_FRONT`、`FACE_PASSIVE_LIVENESS`)。' details: type: object nullable: true additionalProperties: true description: イベント固有のデータです。キーは`event_type`によって異なります。 ip_address: type: string nullable: true description: デバイスがイベントを報告した際のIPアドレス。サーバーで記録されたイベントでは`null`です。 user_agent: type: string nullable: true description: デバイスのユーザーエージェント。サーバーで記録されたイベントでは`null`です。 device_info: type: object nullable: true additionalProperties: true description: SDKまたはブラウザが報告したデバイスの詳細です。 file_url: type: string format: uri nullable: true description: >- イベントに添付されたファイル（キャプチャ画像など）への有効期間の短い署名付きリンク。ファイルがない場合は`null`で、`media: read`を持たないスコープ付きAPIキーでは常に`null`です。 sent_at: type: integer format: int64 description: イベントが発生した日時（ミリ秒単位のUnixタイムスタンプ）。結果はこの値の順に並びます。 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.