メインコンテンツへスキップ
PATCH
curl
フィールドキーは、ワークフローでその書類に設定したキーです。書類とフィールドの設定方法についてはDocument AIを、セッションの判定のどこに結果が表示されるかについてはDocument AIレポートを参照してください。

承認

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(POST /v3/session/が返すsession_id)。ユーザー認証(KYC)と法人確認(KYB)の両方のセッションIDを受け付けます。サーバーは両方のセッションタイプにわたってIDを解決します。正しい形式のUUIDである必要があります。形式が不正な値はルートに一致せず、HTMLの404を返します。

例:

"11111111-2222-3333-4444-555555555555"

documentUuid
string<uuid>
必須

Document AI書類のUUID (GET /v3/session/{sessionId}/decision/内のdocument_ai_documents[].items[].uuid) です。パスで指定したセッションに属している必要があります。

例:

"44444444-5555-6666-7777-888888888888"

ボディ

application/json
extracted_data
object

フィールドキー(書類に設定したキー)とその修正後の値。JSONオブジェクトである必要があり、保存済みのデータにキー単位でマージされます。nullを送信すると400が返るため、送信せずに省略してください。

例:
status
enum<string>

書類の新しいレビューステータス。

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

"Approved"

レスポンス

書類を更新しました。マージ後の書類を返します。

uuid
string<uuid>
必須

書類の識別子。

document_key
string
必須

このアップロードに対応する設定済みの書類。

original_filename
string | null
必須

書類のアップロード時のファイル名。

file_url
string | null
必須

アップロードされたファイルの保存パス。ダウンロードリンクではありません。ファイルをダウンロードするには、セッションの判定から署名付きのfile_urlを取得してください。

status
enum<string>
必須

書類のレビューステータス。

利用可能なオプション:
Not Finished,
Approved,
Declined,
In Review,
Resub Requested
extracted_data
object | null
必須

マージ後に抽出されたすべてのフィールドです。フィールドキーをキーとします。

最終更新日 2026年11月1日