メインコンテンツへスキップ
POST
curl
プレビューしても何も変更されず、何も送信されません。 レスポンスには、send_email: trueを指定してセッションをApprovedまたはDeclinedに設定したときに本人が受け取るメールが、そのままの形で表示されます。 あわせて、誰が受け取るのか、誰から送信されるのか、そして確定したときに実際に送信されるかどうかもわかります。

メールの受信者

メールは本人のメールアドレスに送信されます。ワークフローのメールアドレス認証ステップで本人が検証したアドレスがあればそのアドレスに、なければセッション作成時にcontact_detailsで指定されたアドレスに送信されます。 どちらが適用されるかはrecipient_source(email_verificationまたはcontact_details)で示されます。 セッションに本人のアドレスがない場合、recipient、recipient_source、preview_tokenは空文字列になり、メールは送信できません。 ホワイトラベル設定が適用される場合、メールはアプリケーションの検証済み送信ドメインから送信されます(sender_kind: customer)。それ以外の場合はDiditの送信元から送信されます(sender_kind: didit)。

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

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

判定を確定する

次のフィールドを指定してセッションステータスの更新を呼び出します。 この受領証は15分後に期限切れになります。 プレビュー以降に受信者、言語、セッションのステータス、送信元、またはメールが変わった場合、更新は何も変更する前に409を返します。 もう一度プレビューし、新しい受領証で確定してください。

関連情報

承認

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を受け付けます。

例:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

ボディ

application/json
new_status
enum<string>
必須

メールをプレビューする対象の判定です。

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

"Approved"

email_language
string
デフォルト:en

メールの言語。デフォルトはUpdate Session Statusと同じです。提供されていない言語は英語にフォールバックします。実際に使用される言語はレスポンスのlanguageで確認できます。

例:

"en"

レスポンス

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

recipient
string
必須

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

例:

"person@example.com"

recipient_source
enum<string>
必須

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

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

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

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

例:

"Your verification has been approved in Example App"

html
string
必須

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

例:

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

text
string
必須

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

例:

"Verification Approved\n\nYour identity has been successfully verified with Acme Pay. No further action is needed on your part."

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。status_unchanged:セッションはすでにこのステータスであるため、更新しても何も変わらず、何も送信されません。notification_emails_disabled:セッションがcontact_details.send_notification_emails: trueなしで作成されたため、contact_detailsで指定したアドレスに判定メールは送信されません。no_recipient:本人のアドレスが不明です。sandbox:受信者がサンドボックスでのメール配信をオプトインしていないサンドボックスセッションのため、送信はシミュレーションのみです。

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

null

preview_token
string
必須

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

例:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

最終更新日 2026年11月1日