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

承認

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

ボディ

application/json
email
string<email>
必須

受信者のメールアドレス。形式が不正なアドレスは400を返します。構文上は有効でもメールを受信できないアドレス(DNS/MX検証に失敗したもの)は、status: "Undeliverable"とともに200を返します。

例:

"alice@example.com"

options
object

OTPの形式、ローカライズ、ブランディングのオプション。すべてのフィールドは任意です。

signals
object

エンドユーザーに関するデバイスおよびネットワークの任意のシグナルで、不正利用や自動化されたトラフィックの検出精度を高めるために不正対策レイヤーへ転送されます。すべてのフィールドは任意です。

vendor_data
string

呼び出し側が管理する任意の識別子(社内のユーザーid、メールアドレス、UUIDなど)です。セッションに保存され、送信レスポンス、対応するチェックレスポンス、Webhook、Business Consoleでそのまま返されます。Diditのrequest_idを自社のユーザーレコードと関連付けるために使用してください。

metadata
object | null

セッションに保存される任意の自由形式のJSONオブジェクトです。送信レスポンス、対応するチェックのレスポンス、Webhook、Business Consoleでそのまま返されます。

レスポンス

送信を受け付けました。statusを確認してください。SuccessとRetryはコードが送信中であることを示し、Undeliverableはそのアドレスがメールを受信できず、認証がすでにDeclinedとして確定済みであることを示します。request_idは永続化されたセッションIDです(Retryの場合も同じIDです)。

request_id
string<uuid>

認証のセッションID。Retryによる送信では、元の送信と同じrequest_idが返されます。このIDはBusiness Consoleに表示され、確定済みのPOST /v3/email/check/でも再度返され、GET /v3/session/{sessionId}/decision/に渡すことができます。

status
enum<string>

Success:新しい認証にOTPをメールで送信しました(課金対象)。Retry:以前の送信で作成された保留中の認証に対して、新しいOTPをメールで送信しました(無料)。Undeliverable:メールアドレスが配信可能性の検証に失敗したか、メッセージを送信できませんでした。認証は直ちにDeclinedとして確定し、課金は発生しません。

利用可能なオプション:
Success,
Retry,
Undeliverable
reason
enum<string> | null

statusがUndeliverableの場合はemail_can_not_be_delivered、それ以外の場合はnull。

利用可能なオプション:
email_can_not_be_delivered,
null
vendor_data
string | null

セッションに保存されているvendor_data(最初の送信時のもの)のエコー。

metadata
object | null

セッションに保存されているmetadata(最初の送信時のもの)のエコー。

最終更新日 2026年11月1日