セッションのWebhook配信履歴を一覧取得するAPI

curl

curl -X GET 'https://verification.didit.me/v3/session/22222222-3333-4444-5555-666666666666/webhooks/' \
  -H 'x-api-key: YOUR_API_KEY'

import Didit from "@didit-protocol/sdk-node";

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

const result = await didit.sessions.webhooks.list("22222222-3333-4444-5555-666666666666");
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Sessions.Webhooks.List(ctx, "22222222-3333-4444-5555-666666666666")
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

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

$result = $didit->sessions->webhooks->list('22222222-3333-4444-5555-666666666666');
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Sessions.Webhooks.ListAsync("22222222-3333-4444-5555-666666666666");
Console.WriteLine(JsonSerializer.Serialize(result));

[
  {
    "uuid": "66666666-7777-8888-9999-000000000002",
    "session_id": "22222222-3333-4444-5555-666666666666",
    "request_url": "https://yourapp.com/webhooks/didit",
    "response_status": 200,
    "status": "In Progress",
    "webhook_type": "status.updated",
    "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"9188851d160b5b3aacfc946e4dde1f061b7e568662518942c927ddaf507f533d\", \"X-Signature-V2\": \"381236af514d3fb538579365ac5a24f2464ce1b8224c6e770c60d8201c43ecc5\", \"X-Signature-Simple\": \"4740131dc38f29e78a8508371979be74967d5307464494bd3148a03b4d6c8716\", \"X-Timestamp\": \"1792056139\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}",
    "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792056139,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}",
    "created_at": "2026-10-15T09:22:19.104233Z"
  },
  {
    "uuid": "66666666-7777-8888-9999-000000000001",
    "session_id": "22222222-3333-4444-5555-666666666666",
    "request_url": "https://yourapp.com/webhooks/didit",
    "response_status": 503,
    "status": "In Progress",
    "webhook_type": "status.updated",
    "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"a5e02a03404e1337a0198e6be15d34abbd053c658a0e51e5d0e78554213ef29b\", \"X-Signature-V2\": \"927e7cb770c94ce745939bff73f04aa200015f3bc64795ba46c2aaf78a6cedc5\", \"X-Signature-Simple\": \"e37b0d4c716c72bb5ae7127b9cc455d28ab4686e9e22312b4ec2327409a73302\", \"X-Timestamp\": \"1792056078\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}",
    "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792056078,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}",
    "created_at": "2026-10-15T09:21:18.412345Z"
  }
]

GET

session

{sessionId}

webhooks

curl

curl -X GET 'https://verification.didit.me/v3/session/22222222-3333-4444-5555-666666666666/webhooks/' \
  -H 'x-api-key: YOUR_API_KEY'

import Didit from "@didit-protocol/sdk-node";

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

const result = await didit.sessions.webhooks.list("22222222-3333-4444-5555-666666666666");
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Sessions.Webhooks.List(ctx, "22222222-3333-4444-5555-666666666666")
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

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

$result = $didit->sessions->webhooks->list('22222222-3333-4444-5555-666666666666');
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Sessions.Webhooks.ListAsync("22222222-3333-4444-5555-666666666666");
Console.WriteLine(JsonSerializer.Serialize(result));

[
  {
    "uuid": "66666666-7777-8888-9999-000000000002",
    "session_id": "22222222-3333-4444-5555-666666666666",
    "request_url": "https://yourapp.com/webhooks/didit",
    "response_status": 200,
    "status": "In Progress",
    "webhook_type": "status.updated",
    "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"9188851d160b5b3aacfc946e4dde1f061b7e568662518942c927ddaf507f533d\", \"X-Signature-V2\": \"381236af514d3fb538579365ac5a24f2464ce1b8224c6e770c60d8201c43ecc5\", \"X-Signature-Simple\": \"4740131dc38f29e78a8508371979be74967d5307464494bd3148a03b4d6c8716\", \"X-Timestamp\": \"1792056139\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}",
    "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792056139,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}",
    "created_at": "2026-10-15T09:22:19.104233Z"
  },
  {
    "uuid": "66666666-7777-8888-9999-000000000001",
    "session_id": "22222222-3333-4444-5555-666666666666",
    "request_url": "https://yourapp.com/webhooks/didit",
    "response_status": 503,
    "status": "In Progress",
    "webhook_type": "status.updated",
    "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"a5e02a03404e1337a0198e6be15d34abbd053c658a0e51e5d0e78554213ef29b\", \"X-Signature-V2\": \"927e7cb770c94ce745939bff73f04aa200015f3bc64795ba46c2aaf78a6cedc5\", \"X-Signature-Simple\": \"e37b0d4c716c72bb5ae7127b9cc455d28ab4686e9e22312b4ec2327409a73302\", \"X-Timestamp\": \"1792056078\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}",
    "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792056078,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}",
    "created_at": "2026-10-15T09:21:18.412345Z"
  }
]

5xxまたは404のレスポンスを受けた後にDiditが行う自動再試行も含め、すべての試行が記録されます。そのため、失敗した配信とその後に成功した再試行は、request_body内のevent_idが同じ2件のエントリーとして表示されます。 1件の配信を確認するには、セッションの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ページになります。

レスポンス

このセッションについて記録されたすべての配信を新しい順に示します。

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日