> ## 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.

# Webhook設定の更新API

> Didit Management APIで、アプリケーション単位のWebhookを変更し、シークレットをローテーションし、データ保持と生体認証テンプレートの保持期間を設定し、Digital IDウォレットの戻り先ホストを登録します。



Webhook設定更新APIプロンプト
        プロンプトをクリップボードにコピー



      
      

\<pre>

\`Update my Didit application's webhook configuration through the Management API.

Endpoint:
PATCH https://verification.didit.me/v3/webhook/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs webhooks: write.

Goal:
\- Change application-level settings: the legacy webhook URL and version, the application secret, the data-retention and biometric-template retention policy, the Digital ID wallet return hosts, or the allowed origins of the hosted flow.

Behavior:
\- Partial update: send only the fields to change. The response is the full configuration, the same shape as GET /v3/webhook/.
\- webhook_url and webhook_version change the application-level (legacy) webhook only. Didit uses it only while the application has no enabled destination, and only for status.updated and data.updated. It does not create a destination, and the next create, update or delete of a destination replaces webhook_url. To receive webhooks, create a destination with POST /v3/webhook/destinations/ instead.
\- rotate_secret_key: true replaces the application-level secret_shared_key immediately. Destination secrets are not changed. Each call generates a new secret, so it is not idempotent.
\- data_retention_months (1 to 120, or null for no automatic deletion): user verification sessions older than this many 30-day months are deleted automatically. Business verification sessions are not affected.
\- face_retention_policy (delete_with_session or retain_until_user_deleted) and face_retention_days (1 to 3650). retain_until_user_deleted needs face_retention_days in the same request or already set.
\- allowed_return_hosts replaces the registered list: up to 20 bare hostnames such as app.example.com (no scheme, port, path or wildcard). Send [] to clear it.
\- allowed_domains replaces the list of web origins (for example https://app.example.com; http only for localhost) that the hosted verification flow may be embedded in and may send the user back to with a session callback: up to 50 entries of at most 300 characters. Send [] to remove the restriction. Server-to-server calls are not affected. An invalid entry returns 400 on allowed_domains.
\- Manage destinations with the /v3/webhook/destinations/ endpoints, not here. Never send an endpoints field to this call: it is not part of this contract.

Example call:
curl -X PATCH "https://verification.didit.me/v3/webhook/" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'

What to read from the response:
\- The updated fields, and secret_shared_key when you rotated it: store the new value before you discard the response.

Failure modes:
\- 400: field errors, each field mapped to a list of messages, for example { "face_retention_days": ["A finite retention duration is required when face retention is enabled."] }. Nothing is changed.
\- 401: { "detail": "This API key has expired." }
\- 403: { "detail": "You do not have permission to perform this action." } or { "detail": "This API key has no write access to webhooks." }
\- 429: more than 300 write requests per minute with this key; wait for Retry-After.

Side effects:
\- Rotating the secret changes how deliveries to the legacy webhook_url are signed from then on, retries included.
\- A data_retention_months change applies to existing sessions too: every session older than the new window is deleted automatically, and that deletion is irreversible.
\- A face_retention_policy change applies to session deletions from then on; it creates or purges no existing biometric template.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

貼り付け先

> [!NOTE]
>
> `rotate_secret_key`がローテーションするのはアプリケーションレベルのシークレットのみで、これは従来の`webhook_url`への配信に署名するものです。各[Webhookの送信先](https://docs.didit.me/ja/management-api/webhook/list-destinations.md)はそれぞれ独自の`secret_shared_key`で署名し、この呼び出しでは変更されません。保持期間のフィールドは、**Business Console → App Settings → Data retention**で設定するポリシーと同じものです。変更する前に[データ保持](https://docs.didit.me/ja/console/data-retention.md)、特に[生体認証テンプレートの保持](https://docs.didit.me/ja/console/data-retention.md#生体認証テンプレートの保持)をお読みください。`allowed_return_hosts`については[戻り先の登録](https://docs.didit.me/ja/standalone-apis/digital-id-wallets.md#戻り先を登録する)で説明しています。`biometric_consent_mode`(`auto`、`always`、`never`)は、検証フローが顔の撮影前に生体情報の利用について明示的な同意を求めるタイミングを設定します。[生体情報の同意](https://docs.didit.me/ja/getting-started/biometric-consent.md)をご覧ください。先に現在の値を確認するには、[Webhook設定の取得](https://docs.didit.me/ja/management-api/webhook/get-config.md)を呼び出してください。


## OpenAPI

````yaml ja/openapi-25.json PATCH /v3/webhook/
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/webhook/:
    patch:
      tags:
        - Webhook
      summary: Webhook設定を更新
      description: >-
        アプリケーションレベルの設定を部分的に更新します。対象は、従来のWebhook
        URL、バージョン、シークレット、データおよび生体認証テンプレートの保持ポリシー、Digital
        IDウォレットの戻り先ホストです。変更するフィールドのみを送信してください。レスポンスは`GET
        /v3/webhook/`と同じ形式の完全な設定です。送信先はここでは管理しません。`/v3/webhook/destinations/`エンドポイントで作成、更新、削除してください。また、このエンドポイントに`endpoints`フィールドを送信しないでください。`data_retention_months`の変更は既存のセッションにも適用され、それによって削除されたセッションは復元できません。先に[データ保持](https://docs.didit.me/ja/console/data-retention)をお読みください。スコープ付きAPIキーには`webhooks:
        write`が必要です。
      operationId: update_webhook_config
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 変更するフィールドのみを送信してください。送信先はここでは管理されません。
              properties:
                webhook_url:
                  type: string
                  format: uri
                  nullable: true
                  maxLength: 2000
                  description: >-
                    レガシーのアプリケーションレベルのWebhook
                    URL。Diditは、アプリケーションに有効な送信先がない間のみこのURLを使用し、その場合も`status.updated`と`data.updated`に限られます。このURLによって送信先が作成されることはなく、次に送信先を作成、更新、または削除するとこの値は置き換えられます。Webhookを受信するには、代わりに`POST
                    /v3/webhook/destinations/`で送信先を作成してください。
                webhook_version:
                  type: string
                  enum:
                    - v1
                    - v2
                    - v3
                  description: 従来の`webhook_url`のペイロードバージョン。
                rotate_secret_key:
                  type: boolean
                  default: false
                  description: >-
                    `true`を指定すると、アプリケーションレベルの`secret_shared_key`を新しいランダムな値に即座に置き換えます。新しい値はレスポンスに含まれます。送信先のシークレットは変更されません。`true`を指定した呼び出しは毎回新しいシークレットを生成するため、冪等ではありません。
                capture_method:
                  type: string
                  enum:
                    - MOBILE
                    - MOBILE_AND_DESKTOP
                  description: レガシーのアプリケーション設定。認証フローではこの値は読み取られません。
                data_retention_months:
                  type: integer
                  nullable: true
                  minimum: 1
                  maximum: 120
                  description: >-
                    自動削除までの期間（月単位、1か月は30日として計算）。自動削除しない場合は`null`。変更は既存のセッションにも適用されます。新しい期間より古いユーザー認証セッションはすべて自動的に削除され、この削除は元に戻せません。
                face_retention_policy:
                  type: string
                  enum:
                    - delete_with_session
                    - retain_until_user_deleted
                  description: >-
                    セッションの削除時に、そのセッションの顔エンベディングをどう扱うか。`retain_until_user_deleted`には、同じリクエストで指定するか設定済みの`face_retention_days`が必要です。変更はそれ以降のセッション削除に適用され、既存の生体認証テンプレートを作成または消去することはありません。
                face_retention_days:
                  type: integer
                  nullable: true
                  minimum: 1
                  maximum: 3650
                  description: '`retain_until_user_deleted`における生体認証テンプレートの保持期間（日数）。'
                biometric_consent_mode:
                  type: string
                  enum:
                    - auto
                    - always
                    - never
                  description: >-
                    ホスト型フローとネイティブSDKが、顔の撮影前に本人へ生体認証についての明示的な同意を求める条件です。`auto`（デフォルト）は、トリガーに該当する場合にのみ同意を求めます。該当するのは、申告された州、本人のIP、または本人確認書類の発行元がイリノイ州、テキサス州、コロラド州のいずれかである場合、または州が不明なまま本人が米国にいると見られる場合です。`always`は、ワークフローで顔を撮影するすべての人に同意を求めます。`never`はこのステップを一切表示しないため、セルフィーの前にお客様自身で同意を取得する必要があります。変更はすべて監査ログに記録されます。詳しくは[生体認証の同意](https://docs.didit.me/ja/getting-started/biometric-consent)を参照してください。
                allowed_return_hosts:
                  type: array
                  maxItems: 20
                  description: >-
                    Digital
                    IDウォレットの戻り先ホストのリスト全体を置き換えます。`shop.example.com`のようなホスト名のみを指定します。スキーム、ポート、パス、ワイルドカードは使用できません。値は小文字に変換され、重複は削除されます。リストをクリアするには`[]`を送信します。
                  items:
                    type: string
                    maxLength: 253
                allowed_domains:
                  type: array
                  maxItems: 50
                  items:
                    type: string
                    maxLength: 300
                  description: >-
                    許可されたオリジンのリスト全体を置き換えます。ホスト型検証フローを埋め込むことができ、セッションのコールバックでユーザーを戻すことができるオリジン(例:`https://app.example.com`。`http`は`localhost`の場合のみ)です。サーバー間の呼び出しには影響しません。空のリストは制限なしを意味します。Diditは各オリジンをデフォルトポートなしの小文字で保存します。無効なエントリは`allowed_domains`に対して`400`で失敗します。制限を解除するには`[]`を送信します。
                  example:
                    - https://app.example.com
            examples:
              Enable biometric template retention:
                value:
                  face_retention_policy: retain_until_user_deleted
                  face_retention_days: 365
                  biometric_consent_mode: auto
              Rotate the legacy secret:
                value:
                  rotate_secret_key: true
              Set data retention:
                value:
                  data_retention_months: 24
              Register return hosts:
                value:
                  allowed_return_hosts:
                    - shop.example.com
                    - app.example.com
      responses:
        '200':
          description: >-
            更新後の設定全体で、`GET
            /v3/webhook/`と同じ形式です。シークレットをローテーションした場合は、レスポンスを破棄する前に新しい`secret_shared_key`を保存してください。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookConfig'
              examples:
                Retention enabled:
                  value:
                    webhook_url: https://yourapp.com/webhooks/didit
                    webhook_version: v3
                    secret_shared_key: dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA
                    capture_method: MOBILE
                    data_retention_months: 24
                    face_retention_policy: retain_until_user_deleted
                    face_retention_days: 365
                    biometric_consent_mode: auto
                    available_events:
                      - value: status.updated
                        label: Session status updated
                      - value: data.updated
                        label: Session data updated
                      - value: user.status.updated
                        label: User status updated
                      - value: user.data.updated
                        label: User data updated
                      - value: business.status.updated
                        label: Business status updated
                      - value: business.data.updated
                        label: Business data updated
                      - value: activity.created
                        label: Activity created
                      - value: transaction.created
                        label: Transaction created
                      - value: transaction.status.updated
                        label: Transaction status updated
                      - value: travel_rule.status.updated
                        label: Travel Rule Status Updated
                      - value: workflow.compliance_changed
                        label: Workflow Compliance Changed
                    allowed_return_hosts:
                      - shop.example.com
                    endpoints:
                      - uuid: 11111111-2222-3333-4444-555555555555
                        label: Production session webhooks
                        url: https://yourapp.com/webhooks/didit
                        enabled: true
                        webhook_version: v3
                        secret_shared_key: dGhpcy1pcy1hbi1leGFtcGxlLXNlY3JldC0wMDAwMDA
                        subscribed_events:
                          - status.updated
                          - data.updated
                        created_at: '2026-01-04T08:00:00.000000Z'
                        updated_at: '2026-04-22T14:09:11.523671Z'
        '400':
          description: >-
            バリデーションに失敗しました。無効な各フィールドにメッセージのリストが対応付けられ、何も変更されません。有効なJSONでないボディは`{"detail":
            "JSON parse error - ..."}`を返します。
          content:
            application/json:
              schema:
                type: object
                description: 無効な各フィールドと、それに対応するメッセージのリスト。
                additionalProperties:
                  type: array
                  items:
                    type: string
              examples:
                Retention days missing:
                  value:
                    face_retention_days:
                      - >-
                        A finite retention duration is required when face
                        retention is enabled.
                    biometric_consent_mode: auto
                Retention window out of range:
                  value:
                    data_retention_months:
                      - Ensure this value is less than or equal to 120.
                Invalid return host:
                  value:
                    allowed_return_hosts:
                      - >-
                        'https://shop.example.com' is not a hostname. Register
                        the bare host (e.g. shop.example.com): no scheme, port,
                        path or wildcard.
                Invalid choice:
                  value:
                    face_retention_policy:
                      - '"forever" is not a valid choice.'
        '401':
          description: >-
            APIキーの有効期限が切れています。有効期限を指定して作成され、その期限が過ぎています。誤ったキーや失効したキーでも`401`が返されます。キーがない場合は`403`が返されます。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: 人が読めるエラーメッセージ。
              examples:
                Expired key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            リクエストは許可されていません。`x-api-key`がない、無効、または失効している場合は`You do not have
            permission to perform this
            action.`が返されます。このエンドポイントに必要なアクセス権のないスコープ付きキーには不足しているアクセス権を示すメッセージが返され、IP許可リスト外から使用されたキーには`This
            API key can't be used from this IP address.`が返されます。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: 人が読めるエラーメッセージ。
              examples:
                Missing or invalid key:
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without webhooks write:
                  value:
                    detail: This API key has no write access to webhooks.
                Outside the IP allowlist:
                  value:
                    detail: This API key can't be used from this IP address.
        '429':
          description: >-
            レート制限を超過しました。このAPIキーで、現在の1分間のウィンドウ内に書き込みリクエスト（POST、PATCH、PUT、DELETE）が300件を超えました。`Retry-After`秒待ってから再試行してください。
          headers:
            Retry-After:
              description: 再試行までに待機する秒数。
              schema:
                type: integer
                minimum: 1
                example: 30
            X-RateLimit-Limit:
              description: 1分間のウィンドウで許可されるリクエスト数（300）。
              schema:
                type: integer
                example: 300
            X-RateLimit-Remaining:
              description: 現在のウィンドウで残っているリクエスト数。
              schema:
                type: integer
                example: 0
            X-RateLimit-Reset:
              description: 現在のウィンドウがリセットされるUnix時刻(秒)。
              schema:
                type: integer
                example: 1792056120
            X-RateLimit-Scope:
              description: 超過した予算の名前。
              schema:
                type: string
                example: generic-write
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: 人が読めるエラーメッセージ。
              examples:
                Throttled:
                  value:
                    detail: >-
                      Write request rate limit exceeded. You can make up to 300
                      requests per minute.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X PATCH 'https://verification.didit.me/v3/webhook/' \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.webhooks.update_config(
                face_retention_policy="retain_until_user_deleted",
                face_retention_days=365,
                biometric_consent_mode="auto",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            const result = await didit.webhooks.updateConfig({
              face_retention_policy: "retain_until_user_deleted",
              face_retention_days: 365,
              biometric_consent_mode: "auto",
            });
            console.log(result);
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.WebhooksUpdateConfigParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()
                    .faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of("retain_until_user_deleted"))
                    .faceRetentionDays(365L)
                    .biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of("auto"))
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->webhooks->updateConfig([
                'face_retention_policy' => 'retain_until_user_deleted',
                'face_retention_days' => 365,
                'biometric_consent_mode' => 'auto',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.webhooks.update_config(
              face_retention_policy: "retain_until_user_deleted",
              face_retention_days: 365,
              biometric_consent_mode: "auto"
            )
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await client.Webhooks.UpdateConfigAsync(new
            WebhooksUpdateConfigParams

            {
                FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy("retain_until_user_deleted"),
                FaceRetentionDays = 365,
                BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode("auto"),
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    WebhookConfig:
      type: object
      description: アプリケーションレベルのWebhook設定、保持ポリシー、Digital IDウォレットの戻り先ホスト、およびすべてのWebhookの送信先。
      required:
        - webhook_url
        - webhook_version
        - secret_shared_key
        - capture_method
        - data_retention_months
        - face_retention_policy
        - face_retention_days
        - available_events
        - allowed_return_hosts
        - endpoints
      properties:
        webhook_url:
          type: string
          format: uri
          nullable: true
          description: >-
            アプリケーションレベル（レガシー）のWebhook
            URL。Diditは、アプリケーションに有効な送信先が1つもない間に限りこのURLに送信し、その場合も`status.updated`と`data.updated`のみを送信します。送信先を作成、更新、削除するたびに、この値は最も古い有効な送信先のURL、または有効な送信先がない場合は`null`に設定されます。
        webhook_version:
          type: string
          enum:
            - v1
            - v2
            - v3
          description: 従来の`webhook_url`のペイロードバージョン。各送信先はそれぞれ独自の`webhook_version`を持ちます。
        secret_shared_key:
          type: string
          description: >-
            アプリケーションレベルの署名シークレット（43文字のURLセーフなトークン）。従来の`webhook_url`への配信にのみ署名し、各送信先はそれぞれの`secret_shared_key`で署名します。APIキーで呼び出した場合は常に全体が返されます。`read:webhooks`を持たないConsoleユーザーには空文字列が返されます。
        capture_method:
          type: string
          enum:
            - MOBILE
            - MOBILE_AND_DESKTOP
          description: レガシーのアプリケーション設定。認証フローではこの値は読み取られません。撮影オプションはワークフローごとに設定します。
        data_retention_months:
          type: integer
          nullable: true
          minimum: 1
          maximum: 120
          description: >-
            自動削除までの期間。この月数（1か月は30日として計算）より前に作成されたユーザー認証セッションは自動的に削除され、この削除は元に戻せません。`null`の場合、セッションは自動削除されません。[データ保持](https://docs.didit.me/ja/console/data-retention)を参照してください。
        face_retention_policy:
          type: string
          enum:
            - delete_with_session
            - retain_until_user_deleted
          description: >-
            セッションの削除時に、そのセッションの顔エンベディングをどう扱うか。`delete_with_session`（デフォルト）はセッションとともに削除します。`retain_until_user_deleted`はオプトインの[生体認証テンプレートの保持](https://docs.didit.me/ja/console/data-retention#生体認証テンプレートの保持)です。Userに紐付いた画像を含まない生体認証テンプレートが、保持期間が終了するか、Userが削除されるか、お客様が消去するまで、セッションとは別に管理されます。
        face_retention_days:
          type: integer
          nullable: true
          minimum: 1
          maximum: 3650
          description: >-
            `retain_until_user_deleted`における生体認証テンプレートの保持期間（日数）。このポリシーを設定する場合は必須です。
        biometric_consent_mode:
          type: string
          enum:
            - auto
            - always
            - never
          description: >-
            ホスト型フローとネイティブSDKが、顔の撮影前に本人へ生体認証についての明示的な同意を求める条件です。`auto`（デフォルト）は、トリガーに該当する場合にのみ同意を求めます。該当するのは、申告された州、本人のIP、または本人確認書類の発行元がイリノイ州、テキサス州、コロラド州のいずれかである場合、または州が不明なまま本人が米国にいると見られる場合です。`always`は、ワークフローで顔を撮影するすべての人に同意を求めます。`never`はこのステップを一切表示しないため、セルフィーの前にお客様自身で同意を取得する必要があります。変更はすべて監査ログに記録されます。詳しくは[生体認証の同意](https://docs.didit.me/ja/getting-started/biometric-consent)を参照してください。
        available_events:
          type: array
          description: 送信先がサブスクライブできるすべてのイベントタイプと、その表示ラベルです。
          items:
            type: object
            required:
              - value
              - label
            properties:
              value:
                $ref: '#/components/schemas/WebhookEvent'
              label:
                type: string
                description: 表示ラベルです。例：`Session status updated`。
        allowed_return_hosts:
          type: array
          maxItems: 20
          description: >-
            スタンドアロンのDigital
            IDウォレット検証が`return_url`でユーザーを戻すことができるホスト名(完全一致、HTTPSのみ)です。ホワイトラベルドメインも常に許可されます。[戻り先を登録する](https://docs.didit.me/ja/standalone-apis/digital-id-wallets#戻り先を登録する)を参照してください。
          items:
            type: string
            maxLength: 253
        endpoints:
          type: array
          description: >-
            アプリケーションのすべてのWebhookの送信先を、それぞれの署名シークレットとともに古い順に示します。ここでは読み取り専用です。送信先の管理には`/v3/webhook/destinations/`エンドポイントを使用してください。
          items:
            $ref: '#/components/schemas/WebhookConfigDestination'
        allowed_domains:
          type: array
          maxItems: 50
          items:
            type: string
            maxLength: 300
          description: >-
            ホスト型の検証フローを埋め込むことができ、セッションのコールバックでユーザーを戻すことができるオリジンです（例：`https://app.example.com`。`http`は`localhost`の場合のみ）。サーバー間の呼び出しには影響しません。空のリストは制限なしを意味します。Diditは各オリジンを小文字で、デフォルトポートを除いて保存します。無効なエントリは`allowed_domains`で`400`として失敗します。
          example:
            - https://app.example.com
    WebhookEvent:
      type: string
      description: >-
        サポートされているWebhookイベント名。`subscribed_events`ではこれらの文字列を正確に使用してください。サポートされていない値は拒否されます。
      enum:
        - status.updated
        - data.updated
        - user.status.updated
        - user.data.updated
        - business.status.updated
        - business.data.updated
        - activity.created
        - transaction.created
        - transaction.status.updated
        - travel_rule.status.updated
        - workflow.compliance_changed
        - transaction_rule_suggestions.created
        - auth.signup
        - auth.login
        - auth.login_failed
        - auth.password_reset_requested
        - auth.password_reset_completed
        - auth.mfa_changed
        - auth.new_device
        - auth.account_locked
        - investigator.report.ready
        - investigator.decision.automated
        - investigator.decision.overridden
        - investigator.decision.contested
        - investigator.question.raised
        - investigator.automation.paused
        - investigator.rfi.answered
        - investigator.rfi.overdue
        - investigator.drift.detected
        - investigator.sla.breached
        - investigator.qa.failed
        - investigator.external.report.ready
    WebhookConfigDestination:
      type: object
      description: >-
        Webhook設定に表示されるWebhookの送信先です（配信メトリクスは含みません）。`GET
        /v3/webhook/destinations/{destination_uuid}/`では配信サマリーが追加されます。
      required:
        - uuid
        - label
        - url
        - enabled
        - webhook_version
        - secret_shared_key
        - subscribed_events
        - created_at
        - updated_at
      properties:
        uuid:
          type: string
          format: uuid
          description: 送信先ID。
        label:
          type: string
          maxLength: 255
          description: 人が読める名前。
        url:
          type: string
          format: uri
          maxLength: 2000
          description: DiditがイベントをPOSTするHTTPSエンドポイントです。
        enabled:
          type: boolean
          description: '`false`にすると、この送信先への配信が一時停止されます。'
        webhook_version:
          type: string
          enum:
            - v1
            - v2
            - v3
          description: この送信先に送信されるペイロードバージョン。
        secret_shared_key:
          type: string
          description: >-
            この送信先の署名シークレット(43文字のURLセーフなトークン)。各Webhookは、送信された送信先のシークレットで検証してください。APIキーで呼び出した場合は常に全体が返されます。`read:webhooks`を持たないコンソールユーザーには空文字列が返されます。
        subscribed_events:
          type: array
          uniqueItems: true
          description: この送信先に配信されるイベントタイプです。イベントを指定せずに送信先が作成された場合は空になり、その場合は何も受信しません。
          items:
            $ref: '#/components/schemas/WebhookEvent'
        created_at:
          type: string
          format: date-time
        updated_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.