4つのエンドポイントはいずれも クライアントAPIキー または ユーザー認可ヘッダー を受け付け、成功時には
data.updatedWebhookイベントを送信するため、お客様のシステムや下流の分析と同期を保てます。
共通の要件
- 認可:クライアントAPIキー(標準の
x-api-key/Authorizationbearer)またはユーザー認証トークン。 - 権限:
- KYCとPOA:
write:sessions - KYB企業および主要人物の当事者:
write:businesses
- KYCとPOA:
- セッションのステータス(KYC / POAのみ):
APPROVED、DECLINED、IN_REVIEW、KYC_EXPIREDのいずれかである必要があります。レビュー可能な状態に達していないセッションは更新できません。KYB企業の更新にはステータスによる制限はありません。 - 機能レコードが存在すること:KYCフィールドはセッションでKYC情報を取得した場合のみ、POAフィールドはPOA情報を取得した場合のみ、KYB企業フィールドはセッションに登記チェックがある場合のみ更新できます。
- 部分更新:含めたフィールドのみが変更されます。フィールドを省略すると、そのまま維持されます。
extra_fieldsのキーを削除するにはnullを送信します。 - Webhook:更新が成功すると、
session_kind: "user"または"business"を含むdata.updatedが発行され、セッションの監査証跡に、変更された具体的なフィールドと変更者が記録されます。
KYC本人データの更新
PATCH /v3/session/{sessionId}/update-data/
身分証明書から抽出された任意のフィールドを更新します。オプションのnode_idクエリパラメーターまたはボディ内のフィールドを使用することで、グラフベースのマルチインスタンスワークフローに対応しています。1つのセッションに複数のKYCステップがある場合に、特定のKYCレコードを対象にできます。
変更可能なフィールド
parsed_addressが受け付けるネストされたキーは、address_type、city、region、street_1、street_2、postal_code、country(ISO 3166-1 alpha-2)のみです。
例
?node_id=feature_ocr_2を追加する(またはボディで"node_id": "feature_ocr_2"を渡す)ことで、特定のKYCレコードを対象にできます。
住所証明(POA)データの更新
PATCH /v3/session/{sessionId}/update-poa-data/
住所証明書類から抽出されたフィールドを更新します。適用されるステータス条件と権限はKYCの更新と同じです。マルチインスタンスワークフロー向けのnode_idにも対応しています。
変更可能なフィールド
例
KYBの企業データを更新
PATCH /v3/session/{sessionId}/kyb/{companyUuid}/update-data/
KYB企業の登記から抽出されたフィールドを修正します。このエンドポイントは正規の企業カラムとregistry_dataの両方を編集するため、コンソールの「Extracted from Registry」ビューに修正内容が反映されます。user_provided_data(エンドユーザーがホスト型フローで確認した内容)は変更されません。last_console_edit_atが記録され、trigger: "console_registry_edit"を含むdata.updated Webhookが送信されます。
要件
- 権限:
write:businesses(KYC / POA用の権限とは異なります)。 - URLの
companyUuidは指定したsessionIdに属している必要があります。属していない場合は404が返されます。 - セッションステータスによる制限はありません。KYBの企業データはいつでも修正できます。
変更可能なフィールド
省略したフィールドは変更されません。送信したフィールドは、正規のカラムが存在する場合はそのカラムに書き込まれ、
registry_dataにマージされます。日付はregistry_dataにマージされる際、ISO 8601形式の文字列としてシリアライズされます。
例
registry_checks[].companyと同じ形式です。
主要人物の当事者をスキップ
PATCH /v3/session/{sessionId}/kyb/parties/{partyUuid}/
主要人物の当事者を検証の対象外にします。自身のチェックを決して完了できない当事者のための回避手段です。よくある原因は子セッションの削除です。UBOまたは取締役に割り当てられた個人KYCが削除されると、そのステータスは固定されて決して確定しなくなるため、KYBにはAwaiting Userから移行させる手段が何も残りません。当事者をスキップすると主要人物の集計から除外され、チェックがその場で再計算されるため、セッションが確定し、承認または却下されるようになります。
要件
- 権限:
write:businesses。 - URLの
partyUuidは指定したsessionIdに属している必要があります。属していない場合は404が返されます。 allow_skipによる制限を受けません。 この役割設定は、申請者がホスト型の主要人物画面に入力する際にスキップできる内容を制限するものです。このエンドポイントはオペレーターによる上書きであるため、申請者がスキップできなかった役割でも機能します。
リクエストボディ
requires_verificationは意図的に変更されないため、上書きされた当事者はrequires_verification: true かつ is_skipped: trueと表示されます。記録には、ルールによってチェックが必要とされたことが引き続き示されます。
例
key_people_checks[].submitted.parties[]の要素と同じ形式です。
trigger: "console_key_people_skip"を含むdata.updated Webhookイベントが発生します。
子セッションが削除された当事者は、判定ペイロードで
kyc_session_deleted: true(法人の当事者の場合はkyb_sub_session_deleted: true)としてフラグが付けられ、
リンクが解決できなくなるため、kyc_session_url / kyb_sub_session_urlは
nullとして返されます。子セッションを削除しても、それだけで当事者が承認されることは
決してありません。主要人物チェックはIn Reviewに移行し、人が判断を下します。更新後に起こること
- Webhook: セッションで
data.updatedが発行され、ペイロードにはセッションのsession_kind("user"または"business")が含まれます。送信先レベルで一度サブスクライブし、session_kindで振り分けてください。 - 監査ログ: セッションには、変更されたフィールド、変更前と変更後の値、および(ユーザー認証による呼び出しの場合は)実行者のメールアドレスが正確に記録されます。コンソールの「Events」タブで確認できます。
- 住所の再ジオコーディング:
address/poa_addressを変更するKYCおよびPOAの更新では、Diditがバックグラウンドでジオコーディングを再実行します。失敗は無視されるため、ジオコーディングの問題が原因で更新が失敗することはありません。 - AMLの再評価: 氏名 / 生年月日 / 国籍を変更するKYCの更新は、セッションでAMLが完了していなかった場合、AMLスクリーニングを再トリガーすることがあります。結果はセッションの判定に表示されます。
これらのエンドポイントを使用すべきでない場合
- 検証全体のやり直し: 顧客が身分証明書の写真を撮り直したり、書類を再アップロードしたりする必要がある場合は、代わりにupdate-statusを使用してセッションを
Resubmittedに移行してください。 - UserまたはBusinessエンティティのプロフィールフィールドの変更:
PATCH /v3/users/{vendor_data}/またはPATCH /v3/businesses/{vendor_data}/を使用してください。これらのエンドポイントは、セッションレベルではなくエンティティレベルのデータを更新します。 - 主要人物の詳細の編集: 当事者の名前、役割、所有構造を変更する公開APIはありません。このデータはホスト型フローを通じて送信されます。変更できる唯一のフィールドは
is_skippedです(主要人物の当事者をスキップを参照)。
エラー
次のステップ
セッションの取得
判定全体を取得して、更新されたフィールドを確認します。
ステータスの更新
データの修正後に、セッションを承認、却下、または再オープンします。
Webhook
data.updatedイベントを購読します。