---
title: イベントタイプ
description: IDCloud Webhookイベントタイプのリファレンス — プロセス完了、失敗、およびステータス変更ペイロード。
canonical: https://developer.unico.io/ja/dual-api/developers/webhooks-and-events/event-types
locale: ja
generated_by: markdown-export
---

Webhookのペイロードはプロセスの状態遷移を表します。このページでは、ペイロードのスキーマと `lastEvent` の全列挙値について説明します。

### ペイロードスキーマ

| フィールド | 型 | 説明 |
|---|---|---|
| `processId` | `string` (UUID) | トランザクションのID。 |
| `state` | `string` | トランザクションの現在の状態。現在の値: `PROCESS_STATE_FINISHED`。 |
| `flow` | `string` | このトランザクションに対して実行されたフロー（例: `id`、`idtoken`）。 |
| `lastEvent` | `string` | トランザクションの最後のイベント。**ユーザーがフローを完了する前にプロセスが期限切れになった場合のみ返されます。** |
| `lastEventDescription` | `string` | `lastEvent` の人間が読める説明。**ユーザーがフローを完了する前にプロセスが期限切れになった場合のみ返されます。** |

:::note[ステータスの語彙]
Webhookペイロードの `state` フィールドは `PROCESS_STATE_*` プレフィックスを使用します。これは、GetProcessエンドポイントが返す `result` および `status` フィールド（`PROCESS_RESULT_*` を使用）とは異なる語彙です。これらを互換的に扱わないでください。
:::

### ペイロードの例

#### 完了 — 成功

```json
{
  "processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "state": "PROCESS_STATE_FINISHED",
  "flow": "id"
}
```

#### 完了 — 期限切れ

```json
{
  "processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "state": "PROCESS_STATE_FINISHED",
  "flow": "id",
  "lastEvent": "EVENT_TYPE_SESSION_ENDED",
  "lastEventDescription": "Session ended by timeout or by new session created"
}
```

### lastEvent の列挙値

`lastEvent` に含まれる可能性のある値の一覧:

| イベント | 説明 |
|---|---|
| `EVENT_TYPE_PROCESS_CREATED` | プロセスが作成されました |
| `EVENT_TYPE_QR_CODE_READ` | QRコードが読み取られました |
| `EVENT_TYPE_PROCESS_STARTED_BY_USER` | ユーザーによってプロセスが開始されました |
| `EVENT_TYPE_IDENTITY_VALIDATION_STEP_FINISHED` | 本人確認ステップが完了しました |
| `EVENT_TYPE_DOCUMENT_STEP_STARTED` | ドキュメントステップが開始されました |
| `EVENT_TYPE_DOCUMENT_PHOTO_CAPTURED` | ドキュメントの写真が撮影されました |
| `EVENT_TYPE_DOCUMENT_UPLOADED_FROM_GALLERY` | ギャラリーからドキュメントがアップロードされました |
| `EVENT_TYPE_DOCUMENT_STEP_FINISHED` | ドキュメントステップが完了しました |
| `EVENT_TYPE_SESSION_ENDED` | タイムアウトまたは新しいセッションの作成によりセッションが終了しました |
| `EVENT_TYPE_ERROR_ON_DOCUMENT_STEP` | ドキュメントステップでエラーが発生しました |

:::secondary[設定可能な処理]
イベントのセットは変更される可能性があります。エンドポイントが反応するイベントは**設定**として扱い、ハードコードされた定数にしないでください — そうすることで、デプロイなしに新しいイベントを有効化できます。
:::

### 完全なプロセス結果の取得

Webhookのペイロードはプロセスの完了を通知しますが、結果自体は含まれません。結果（キャプチャデータ、生体認証スコア、ドキュメントフィールドなど）を取得するには、適切な **GetProcess** エンドポイントを呼び出してください:

- ビジュアル / Web & ネイティブ フロー: [APIリファレンス > Web & ネイティブ > GET /v1/process/{id}](/dual-api/developers/api-reference/web-sdk) を参照してください。
- 非ビジュアル / API フロー: [APIリファレンス > API > GET /processes/v1/{id}](/dual-api/developers/api-reference/api) を参照してください。