Webhooks(ウエブフック)

Webhooksを使用すると、k-IDエンジン内で発生しているイベントをリアルタイムで購読できます。これにより、APIをポーリングしてデータが利用可能かどうかを確認する必要がなくなります。

Webhooksは、さまざまな目的に使用できます。例えば：

1. 成人認証結果の処理
2. 年齢保証結果の処理

Webhooksの設定

Webhooksは、Publisher Portalで設定します。イベントが発生した際にk-IDエンジンが呼び出すURLを指定します。このURLは、セキュアなHTTPS URLでなければなりません。k-IDエンジンは、イベントデータを含むJSONペイロードを持ったPOSTリクエストをこのURLに送信します。

Webhookイベント構成

Webhook URLに送信されるJSONペイロードには、次のフィールドが含まれます：

• eventType - 発生したイベントの種類。
• data - イベントに関連するデータ。

イベントタイプを含むX-Event-Typeヘッダーも一緒に送信されます。

将来的には、リクエストの信頼性を確認するために、追加のヘッダーも送信される予定です。

Webhookイベント種類

利用可能なイベントタイプは次のとおりです：

• AdultVerification.Result
• AgeAssurance.Result

大人認証結果

プロパティ：

• id - 一意の認証ID。
• status - PASS, FAIL, または INCONCLUSIVE可能なステータス
• ageRange (任意) - Details about the estimated age range.

ageRange プロパティ：

• minAge - 推定される最小年齢
• maxAge - 推定される最高年齢
• confidence - 推定された年齢範囲に対する信頼度を示す0から1の数値。

例のペイロード:

{
  "eventType": "AdultVerification.Result",
  "data": {
    "id": "5a58e98a-e477-484b-b36a-3857ea9daaba",
    "status": "PASS"
  }
}

年齢保証結果

プロパティ：

• id - 一意の認証ID。
• status - PASS, FAIL, または INCONCLUSIVE可能なステータス
• ageRange (任意) - Details about the estimated age range.

ageRange プロパティ：

• minAge - 推定される最小年齢
• maxAge - 推定される最高年齢
• confidence - 推定された年齢範囲に対する信頼度を示す0から1の数値。

例のペイロード:

{
  "eventType": "AgeAssurance.Result",
  "data": {
    "id": "5a58e98a-e477-484b-b36a-3857ea9daaba",
    "status": "PASS",
    "ageRange": {
      "minAge": 18,
      "maxAge": 25,
      "confidence": 0.8
    }
  }
}