メインコンテンツへスキップ
GET
curl
request_body内のペイロードはWebhookで説明しているもので、ヘッダーは署名検証で解説しているものです。配信を再送するには、セッションのWebhook配信の再送を使用します。

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

パスパラメータ

sessionId
string<uuid>
必須

ユーザー(KYC)または企業(KYB)の検証セッションのUUID。POST /v3/session/が返すsession_idです。サーバーは両方のセッションタイプに対してIDを解決します。

有効なUUIDである必要があります。 ルートは正しい形式のUUIDにのみ一致するため、形式が不正な値はアプリケーションコードが実行される前にURLルーターで拒否され、レスポンスは以下に示すJSONの{"detail": ...}エンベロープではなく、404のHTMLページになります。

webhook_uuid
string<uuid>
必須

配信のUUIDで、GET /v3/session/{sessionId}/webhooks/が返すエントリーのuuidです。パスで指定したセッションに属している必要があります。

レスポンス

リクエストヘッダーとボディを含む配信です。

認証セッションについて記録されたWebhook配信の試行1件です。Diditが送信した正確なリクエストヘッダーと本文を含みます。

uuid
string<uuid>
必須

配信ID。この配信を取得または再送するには、{webhook_uuid}として使用します。

session_id
string<uuid>
必須

配信が属するセッション(パスで指定したセッション)。

request_url
string<uri> | null
必須

配信の送信先URL。

response_status
integer | null
必須

エンドポイントが返したHTTPステータス。配信がキューに入っていてまだ試行されていない間はnullです。HTTP応答を受信しなかった場合、Diditは独自のステータスを記録します。エンドポイントが5秒以内に応答しなかった場合は504、接続に失敗した場合は503、URLが安全でないとして拒否された場合(プライベートアドレスや内部アドレスなど)は400、その他のリクエストエラーの場合は404です。400以上は配信失敗とみなされます。

status
string | null
必須

イベント生成時点のセッションステータス(例: In Progress、Approved、Declined)。

webhook_type
enum<string>
必須

サポートされているWebhookイベント名。subscribed_eventsではこれらの文字列を正確に使用してください。サポートされていない値は拒否されます。

利用可能なオプション:
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
request_header
string
必須

Diditが送信したリクエストヘッダー(Content-Type、X-Signature、X-Signature-V2、X-Signature-Simple、X-Timestamp、User-Agent)のJSONテキスト(文字列)です。JSONパーサーで解析してください。署名は含まれますが、署名用シークレットは決して含まれません。

request_body
string
必須

Diditが送信したペイロードそのもののJSONテキスト(文字列)です。キーはソートされ、event_idとtimestampを含みます。JSONパーサーで解析してください。ペイロードの形式を参照してください。media: readを持たないスコープ付きキーの場合、その中のメディアURLはnullになります。sessions: writeを持たない場合、セッショントークンとホスト型検証リンクはnullになります。このように変更された本文は、署名と一致しなくなります。Diditは、お使いのエンドポイントが返したレスポンス本文を記録しません。

created_at
string<date-time>
必須

配信が作成された日時。

最終更新日 2026年11月1日