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

このエンドポイントでできること

AMLスクリーニングはヒットのリストを返します。ヒットとは、制裁リスト、PEPデータベース、ウォッチリスト、ネガティブメディアとの一致の可能性がある項目です。各ヒットにはreview_status(レビュー状況)があり、一致スコアに応じてUnreviewedまたはFalse Positiveのいずれかで始まります。このエンドポイントを使うと、セッション全体の判定を変更せずに、チーム(または自動化処理)が各ヒットに対する判定を記録できます。 ヒットとそのIDはセッションの判定で確認できます。AMLチェックのhits配列に含まれており、各ヒットのidがここで渡すhit_idです。 ヒットのidはhit_に続く24文字の16進数で構成され、対象が再スクリーニングされても変わりません。以前の形式で返されたヒットIDも引き続き受け付けられます。レスポンスでは常に現在のidでヒットを示します。

レビューステータス

レビュアーの判定は継続的なモニタリングによる再スクリーニングでも保持されます。False Positiveとマークしたヒットは、プロバイダーが対象を再スクリーニングしてもそのステータスを維持します。

単一ヒットの更新

PATCH /v3/session/{sessionId}/update-aml-hit-status/
複数のAMLチェックを含むセッション(グラフワークフロー)では、URLに?node_id=feature_aml_1を追加するか、リクエストボディに"node_id"を含めて、対象のチェックを指定します。

複数ヒットの一括更新

PATCH /v3/session/{sessionId}/bulk-update-aml-hit-status/ hit_updatesに、{ hit_id, review_status }のペアのリストを渡します。この操作はオールオアナッシングです。いずれかのhit_idが見つからない場合、リクエストは404を返し、どのヒットも変更されません。
一括呼び出しが成功すると、data.updatedのWebhookが1回だけ送信され、すべての変更をまとめた1件のアクティビティが記録されます。

更新後に発生すること

  • Webhook:セッションでdata.updatedイベントが発生します。
  • 監査証跡:変更は実行者(APIキーまたはユーザー)とともにセッションのレビュー履歴に記録され、コンソールのアクティビティタイムラインで確認できます。
  • AMLステップ全体のステータスは変わりません:ヒットの処理結果を変更しても、それだけではAMLステップのステータスやセッションの判定は変わりません。AMLステップのステータス(Approved / Declined / In Review)を変更するにはupdate-feature-statusを使用します。セッションの判定を変更するにはupdate-statusを使用します。

KYCとKYBのサポート

本人確認(KYC)、法人確認 (KYB)、どちらのセッションでも動作します。Diditはどちらの場合もsessionIdを解決します。KYBでは、AMLスクリーニングは企業とその主要人物に対して実行され、各AMLチェックでは、それぞれのヒットを確認できます。

権限

write:sessions権限が必要です。クライアントAPIキー(x-api-key)またはユーザー認証ヘッダーのいずれかを使用します。

エラー

関連ページ

承認

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>
必須

検証セッションのUUID。ユーザー(KYC)と企業(KYB)の両方のセッションIDを受け付けます。サービスは両方のセッションタイプにわたってIDを解決します。

例:

"11111111-2222-3333-4444-555555555555"

クエリパラメータ

node_id
string

ワークフローグラフのノードID。セッションに複数のAMLチェック(ノードごとに1つ)がある場合にのみ必須です。AMLチェックが1つだけのセッションでは省略してください。

例:

"feature_aml_1"

ボディ

application/json
hit_id
string
必須

AMLチェックのhits配列に含まれるヒットのid(hit_...)です。以前の形式で返されたヒットIDも引き続き受け付けます。

例:

"hit_7c1e9a40b2d35f86e0a4c912"

review_status
enum<string>
必須

ヒットの新しいレビューステータス。

利用可能なオプション:
Unreviewed,
Confirmed Match,
False Positive,
Inconclusive
例:

"False Positive"

node_id
string

任意のグラフノードIDです。セッションに複数のAMLチェックがある場合に、ここまたはクエリパラメーターとして指定します。

例:

"feature_aml_1"

レスポンス

ヒットのレビューステータスが更新されました。

message
string
必須

常にHit status updated successfullyです。

hit_id
string
必須

更新されたヒットのidで、セッションの判定が返す形式です。リクエストが以前の形式のIDでヒットを指定した場合も同様です。

review_status
enum<string>
必須

ヒットに現在保存されているレビューステータスです。

利用可能なオプション:
Unreviewed,
Confirmed Match,
False Positive,
Inconclusive
最終更新日 2026年11月1日