メインコンテンツへスキップ
POST
Python
プレビューを実行しても、セッションは変更されず、メールも送信されません。 レスポンスを確認したら、セッションステータスの更新で確定し、返されたpreview_tokenをemail_preview_tokenとして渡します。 このレシートの有効期限は15分です。 変更された、または期限切れのレシートを渡すと、セッションが変更されたりメールが送信されたりする前に409が返されます。 競合が発生した場合は、新しいプレビューを生成してください。 既存のAPI連携ではレシートを省略できます。コンソールは、プレビューを確定する際にレシートを渡します。 送信者とブランディングは、既存のホワイトラベル設定に従います。 メッセージの内容は翻訳済みの認証テンプレートから生成されます。任意の件名、本文、アクションURLをテンプレートの入力として指定することはできません。

メールの受信者

email_addressは省略可能です。 指定しない場合、メールは本人のアドレスに送信されます。フローのメールアドレス認証ステップで本人が認証したアドレスがあればそのアドレス、なければセッション作成時にcontact_detailsで指定されたアドレスです。 email_addressでアドレスを渡した場合は、そのアドレスが優先されます。 recipient_sourceは、どのアドレスが適用されるかを示します。

メールが送信されるかどうか

will_be_sentは、send_email: trueを指定して再提出を確定したときにメールが送信される場合にtrueになります。 falseの場合は、not_sent_reasonにその理由が示されます。

再提出の確定

以下のフィールドを指定してセッションステータスの更新を呼び出します。 レスポンスのlanguageは、メールの言語です。指定した言語が提供されていない場合は英語になります。

バックエンドのみで繰り返し再提出する場合

再提出するすべてのステップが本人の操作なしで実行される場合(AML、データベース検証、IP分析)、その人のセッションを再提出できるのは30秒に1回までです。 この期間内は、セッションステータスの更新と同様にプレビューも429を返し、待機時間はRetry-Afterヘッダーに示されます。

関連情報

承認

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"

ボディ

application/json
nodes_to_resubmit
object[]

プレビューするステップ。再提出と同じ検証、選択、ワークフローの順序が使われます。省略すると、再提出が必要な記録済みの試行が自動的に選択されます。

email_address
string<email>

任意。本人のアドレスではなく、このアドレスにメールを送信します。指定しない場合、受信者はフロー内で本人が認証したアドレス、それがなければcontact_detailsで指定されたアドレスになります。この呼び出しではメールは送信されません。

例:

"user@example.com"

email_language
string
デフォルト:en

通知メールの言語。スキーマ上は任意の文字列を受け付けますが、対応していないコードは通知なく英語(en)にフォールバックします。

例:

"en"

レスポンス

プレビューのみです。セッションは変更されず、メールも送信されません。

recipient
string
必須

メールの送信先アドレス。その人物のアドレスが不明な場合は空文字列です。その場合はメールを送信できず、preview_tokenも空になります。確認時にemail_addressとして渡してください。

例:

"person@example.com"

recipient_source
enum<string>
必須

recipientの取得元。request:指定したemail_address。email_verification:フローのメールアドレス認証ステップで本人が認証したアドレス。contact_details:セッション作成時にcontact_detailsで指定されたアドレス。アドレスがない場合は空文字列です。

利用可能なオプション:
email_verification,
contact_details,
request,
例:

"email_verification"

sender
string
必須

メールの送信時に使われるFromヘッダーです。

例:

"Example App <no-reply@mail.example.com>"

sender_name
string
必須

senderの表示名の部分です。

例:

"Example App"

sender_email
string<email>
必須

senderのアドレス部分。

例:

"no-reply@mail.example.com"

sender_kind
enum<string>
必須

customer: メールはアプリケーションの検証済み送信元ドメインから送信されます(ホワイトラベル)。didit: メールはDidit独自の送信元から送信されます。

利用可能なオプション:
customer,
didit
例:

"customer"

subject
string
必須

送信されたとおりの件名。

例:

"Action Required: Complete your verification in Example App"

html
string
必須

送信されるとおりのメールのHTMLで、ロゴはデータURLとして埋め込まれています。サンドボックス化されたフレーム内でレンダリングし、アプリケーションのDOMに直接レンダリングしないでください。

例:

"<!DOCTYPE html><html><body>...</body></html>"

text
string
必須

コンパクトなプレビュー用の、メール本文のプレーンテキストです。本人のメッセージスレッドに保存されている内容と同じです(本人が受け取るメールはHTMLのままです)。

例:

"Almost there\n\nSome steps need to be completed again.\nHere’s what to fix:\n\nhttps://verify.didit.me/session/abc123"

language
string
必須

メールの記述言語です。指定したemail_languageが提供されていない場合は英語(en)です。

例:

"en"

will_be_sent
boolean
必須

send_email: trueで変更を確定したときにこのメールが送信されるかどうかです。not_sent_reasonが設定されている場合はfalseです。

例:

true

not_sent_reason
enum<string> | null
必須

確定してもメールが送信されない理由、または送信される場合はnull。no_user_action:選択されたすべてのステップが本人の操作なしで実行されるため、再提出は自動的に完了し、メールは送信されません。no_recipient:本人のアドレスが不明で、あなたも指定していません。sandbox:受信者がサンドボックスでのメール配信をオプトインしていないサンドボックスセッションのため、送信はシミュレーションのみです。

利用可能なオプション:
no_user_action,
no_recipient,
sandbox,
null
例:

null

nodes_to_resubmit
object[]
必須
requires_user_action
boolean
必須

選択したチェックのうち少なくとも1つがユーザーの操作を必要とするかどうかです。ワークフローの最終結果を予測するものではありません。

preview_token
string
必須

このメールに対する署名付きレシートで、有効期間は15分です。セッションステータスを更新にemail_preview_tokenとして渡してください。受信者がいない場合は空文字列です。

例:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

最終更新日 2026年11月1日