メインコンテンツへスキップ

イベントタイプ

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

ペイロードスキーマ​

フィールド型説明
processIdstring (UUID)トランザクションのID。
statestringトランザクションの現在の状態。現在の値: PROCESS_STATE_FINISHED。
resultstring完了したプロセスの結果。state=PROCESS_STATE_FINISHED のときに存在します。指定可能な値: ok、expired、invalid_identity。
flowstringこのトランザクションに対して実行されたフロー（例: id、idtoken）。
lastEventstringトランザクションの最後のイベント。result=expired の場合のみ返されます。
lastEventDescriptionstringlastEvent の人間が読める説明。result=expired の場合のみ返されます。
ステータスの語彙

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

ペイロードの例​

完了 — 成功​

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

完了 — 期限切れ​

{
  "processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "state": "PROCESS_STATE_FINISHED",
  "flow": "id",
  "result": "expired",
  "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_READQRコードが読み取られました
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ドキュメントステップでエラーが発生しました
設定可能な処理

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

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

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

最終更新 に