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

この機能でできること

認証セッションは、ID/OCR、ライブネス、顔照合、AML、住所証明、電話番号などの個別の機能(ステップ)で構成されています。 このエンドポイントでは、それらのステップのうち1つのステータスをApproved、Declined、In Reviewのいずれかに設定できます。 セッション全体を承認、却下、または再開したい場合はupdate-statusを使用してください。 単一のステップについてのみ判定を記録したい場合、たとえば独自のレビューワークフローのために顔照合ステップをDeclinedとしてマークしたい場合は、このエンドポイントを使用してください。 すでに判定が出ているセッションでは、その判定は維持され、変更されるのはステップのみです。 セッションにまだ判定がなく、ワークフローがまさにこのステップを待っている場合、オーバーライドを適用すると、通常どおりステップを完了した場合と同様にそのステップが完了します。 ワークフローは先に進み、後続のステップが実行され、ステータスノードがセッションの判定を設定してstatus.updated Webhookを送信することがあります。

node_idでステップを指定する

グラフベースのワークフローでは、各ステップにnode_id(例:feature_ocr_1、feature_liveness_1、feature_aml_1)があります。これらはセッションの判定で確認できます。V3の判定に含まれる各機能にはnode_idが付与されています。 グラフを使わない(単一ステップの)ワークフローでは、基盤となる機能にノードIDがありません。対象にするには、nodeIdとしてリテラル値defaultを渡してください。 このようなワークフローのステップにはいずれもノードIDがないため、どのステップを指すかを示すためにfeature_type(例:LIVENESS、AML、FACE_MATCH)もあわせて渡してください。 不明なfeature_typeを指定すると400が返されます。

本人がフローを完了するまで待つ

デフォルトでは、オーバーライドは即座に適用されます。 本人がまだフローを進めている途中の場合、実行中のフローのステップを変更することになり、その際オーバーライドはforced: trueとして記録されます。 待機させるにはdefer_until_flow_finishes: trueを設定してください。 セッションがNot Started、In Progress、Resubmittedのいずれかで、本人がまだ完了していない間は、オーバーライドはpending_until_flow_finishesとして保存されます。 本人がフローを完了し、フロー自体の判定が出た後に適用されます。 フローがすでに終了しているセッションでは、どちらの設定でも即座に適用されます。 待機中のオーバーライドは、次の場合には適用されずにキャンセルされます。
  • 本人が完了前にそのステップをやり直した場合(check_changed)
  • 同じステップに対する新しいオーバーライドで置き換えられた場合(replaced)
  • セッションがフロー未完了のまま終了した場合:放棄、期限切れ、またはフローの途中で判定が出た場合(session_closed)
  • Cancel Feature Overrideでキャンセルした場合(cancelled_by_reviewer)
レスポンスのoverrideで結果を確認できます。stateはappliedまたはpending_until_flow_finishesで、適用されるとapplied_atが設定されます。 トップレベルのnew_statusはステップに保存されているステータスであるため、オーバーライドが待機している間は変わりません。 セッションのすべてのオーバーライドと、本人がまだフロー内にいるかどうかを確認するには、List Feature Overridesを使用してください。

KYCとKYBへの対応

本人確認(KYC)と法人確認 (KYB)のどちらのセッションでも同じように動作します。Diditは両方を対象にsessionIdを解決します。対応するステップの種類には、ID/OCR、ライブネス、顔照合、NFC、AML、住所証明、電話番号、メールアドレス、データベース検証、アンケート、およびKYBの登記・書類・主要人物のチェックが含まれます。
スタンドアロンAPIセッション(スタンドアロン検証APIで作成されたセッション、session_type = API)では、各機能のステータスを変更できません。エンドポイントは400を返します。

例

更新後の動作

  • Webhook:オーバーライドが適用されたとき(即座に、またはフロー完了時)にdata.updatedイベントが送信されます。待機中やキャンセル時には何も送信されません。
  • アクティビティ:すべてのオーバーライドは、セッションのアクティビティにFEATURE_OVERRIDE_PENDING、FEATURE_OVERRIDE_APPLIED、FEATURE_OVERRIDE_CANCELLEDのいずれかとして、実行者(APIキー、ユーザー、または待機中のオーバーライドが適用された場合はシステム)とともに記録されます。リクエストのエントリには、理由として指定したcommentが記録されます。セッションの判定のreviews配列では、これらのエントリはnew_status: nullとして表示され、リクエストのエントリにはcommentに理由が含まれます。
  • セッションの判定:すでに判定が出ているセッションでは、その判定が維持されます。最終判定を変更するには、別途update-statusを呼び出してください。

権限

write:sessions権限と、クライアントAPIキー(x-api-key)またはユーザー認可ヘッダーのいずれかが必要です。 スコープ付きAPIキーには、判定への書き込みアクセスが必要です。

関連情報

承認

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"

nodeId
string
必須

更新する機能のワークフローグラフのノードID(例: feature_ocr_1)。機能にノードIDがない非グラフ(単一ステップ)のワークフローでは、リテラル値defaultを使用してください。

例:

"feature_ocr_1"

ボディ

application/json
new_status
enum<string>
必須

この機能の変更後のステータス。現在の値と異なる必要があります。

利用可能なオプション:
Approved,
Declined,
In Review
例:

"Approved"

comment
string

この機能変更について、セッションのレビュー履歴に記録される任意の自由記述のメモです。

例:

"Document manually verified by compliance."

feature_type
enum<string>

対象とするステップの種類。グラフ以外のワークフロー(nodeId = default)では、すべてのステップに個別のノードがないため必須です。それ以外の場合は任意です。不明な値を指定すると400が返されます。

利用可能なオプション:
ID_VERIFICATION,
OCR,
OCR_BACK,
NFC,
LIVENESS,
FACE,
AGE_ESTIMATION,
AGE_VERIFICATION,
FACE_SEARCH,
FACE_MATCH,
IP_ANALYSIS,
AML,
PHONE,
PHONE_VERIFICATION,
EMAIL,
EMAIL_VERIFICATION,
POA,
PROOF_OF_ADDRESS,
DATABASE_VALIDATION,
DATA_VALIDATION,
QUESTIONNAIRE,
DOCUMENT_AI,
KYB_REGISTRY,
KYB_DOCUMENTS,
KYB_KEY_PEOPLE,
BANK_VERIFICATION,
GEOLOCATION
例:

"LIVENESS"

defer_until_flow_finishes
boolean
デフォルト:false

本人がまだフロー内にいる間は、オーバーライドを即座に適用せずpending_until_flow_finishesとして保存し、フローの終了時に適用します。省略した場合またはfalseの場合、オーバーライドは即座に適用されます。フローがすでに終了しているセッションでは、どちらの場合も即座に適用されます。

例:

false

レスポンス

オーバーライドが記録されました。new_statusは保存されているチェックのステータスです。オーバーライドが適用された場合はリクエストされたステータス、フローの完了を待っている間は変更前のステータスになります。どちらになったかはoverrideで示されます。

session_id
string<uuid>
必須
node_id
string | null
必須

更新されたステップのワークフローノード。ノードのないステップ(グラフ形式でないワークフローにおけるdefaultパス)の場合はnull。

例:

"feature_ocr_1"

feature_type
string
必須

更新された機能のモデル名(例: KYC、Face、FaceMatch、AML、POA)。

例:

"KYC"

new_status
string
必須

保存されているチェックのステータス。オーバーライドが適用された後はリクエストされたステータス、オーバーライドがフローの完了を待っている間は変更前のステータスです。

例:

"Approved"

override
object
必須

PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/で行ったチェック(機能)ステータスの上書き1件です。何を変更するか、適用済みか、まだ本人がフローを完了するのを待っているか、誰がなぜ依頼したかを示します。

最終更新日 2026年11月1日