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

インテリジェンスアドオン

enable_enrichmentをtrueに設定すると、アドレスに対してメールインテリジェンスも実行され、リスクスコアと過去の漏洩履歴が得られます。 このアドオンは、チェックの料金に加えて、定価でリクエスト1件あたり$0.05が請求されます。 残高が不足している場合、リクエストは403を返します。 シグナルの扱いは3つのフィールドで決まります。 いずれもNO_ACTION(デフォルト)またはDECLINEを指定でき、enable_enrichmentがtrueの場合にのみ有効になります。 NO_ACTIONの場合でもシグナルはemail.email_intelligenceで返されるため、独自のルールを適用できます。

承認

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

対応するPOST /v3/email/send/の呼び出しで使用したものと同じメールアドレスです。この値によって、確認と送信が紐付けられます。

例:

"alice@example.com"

code
string
必須

エンドユーザーが受け取ったOTP。4〜8桁の数字、または送信時にalphanumeric_code: trueを使用した場合は4〜8文字の英数字です。比較では大文字と小文字は区別されません。

Maximum string length: 10
例:

"123456"

duplicated_email_action
enum<string>
デフォルト:NO_ACTION

同じメールアドレスが、アプリケーションの別のユーザー(異なるvendor_data)によってすでに使用され、承認されている場合の対応です(過去に承認済みとなった認証のみが対象です)。DECLINEは最終的なstatusをDeclinedに切り替え、NO_ACTIONはリスクをemail.warningsに記録してemail.matchesを設定します。

利用可能なオプション:
NO_ACTION,
DECLINE
breached_email_action
enum<string>
デフォルト:NO_ACTION

メールアドレスが既知のデータ漏えいに含まれている場合の処理です(email.is_breached)。DECLINEは最終的なstatusをDeclinedに変更し、NO_ACTIONはリスクをemail.warningsに記録します。

利用可能なオプション:
NO_ACTION,
DECLINE
disposable_email_action
enum<string>
デフォルト:NO_ACTION

ドメインが使い捨て/一時メールのプロバイダーに属する場合(email.is_disposable)の対応です。DECLINEは最終的なstatusをDeclinedに切り替え、NO_ACTIONはリスクをemail.warningsに記録します。

利用可能なオプション:
NO_ACTION,
DECLINE
enable_enrichment
boolean
デフォルト:false

trueの場合、そのアドレスに対してメールインテリジェンスも実行します(リスクスコアと漏洩履歴)。このエンドポイント自体の料金に加えて、リクエストごとにemail_intelligence_api1ユニット(定価で$0.05)として課金されます。残高が不足している場合、リクエストは403を返します。

例:

false

email_intelligence_score_action
enum<string>
デフォルト:NO_ACTION

メールインテリジェンスのリスクスコアがしきい値を超えた場合のアクション。DECLINEは最終的なstatusをDeclinedに変更し、NO_ACTIONは却下せずにシグナルを記録します。enable_enrichmentがtrueの場合にのみ有効です。

利用可能なオプション:
NO_ACTION,
DECLINE
recent_email_breach_action
enum<string>
デフォルト:NO_ACTION

メールアドレスが最近の既知のデータ侵害に含まれている場合のアクション。DECLINEは最終的なstatusをDeclinedに変更し、NO_ACTIONは却下せずにシグナルを記録します。enable_enrichmentがtrueの場合にのみ有効です。

利用可能なオプション:
NO_ACTION,
DECLINE
frequent_email_breach_action
enum<string>
デフォルト:NO_ACTION

メールアドレスが多数の既知のデータ侵害に含まれている場合のアクション。DECLINEは最終的なstatusをDeclinedに変更し、NO_ACTIONは却下せずにシグナルを記録します。enable_enrichmentがtrueの場合にのみ有効です。

利用可能なオプション:
NO_ACTION,
DECLINE
enable_social
boolean
デフォルト:false

trueの場合、アドレスのソーシャルフットプリント(そのアドレスが登録されているメール、ソーシャル、ビジネス、EC、エンターテインメントの各プラットフォーム)も検索します。このエンドポイント自体の料金に加えて、リクエスト1件ごとにemail_social1ユニット分が請求されます。

例:

true

email_no_social_presence_action
enum<string>
デフォルト:NO_ACTION

ソーシャルフットプリントチェックで、対象となるいずれのプラットフォームにもこのメールアドレスが登録されていないと判明した場合のアクション。このエンドポイントで指定できるのはNO_ACTIONとDECLINEのみです。REVIEWは、ワークフロー設定の同名のキーで利用できます。

利用可能なオプション:
NO_ACTION,
DECLINE

レスポンス

チェックが完了しました。誤ったコードや存在しない検証の場合も200が返るため、HTTPコードではなくstatusを確認してください。emailは確定した結果(Approved/Declined)の場合のみ値が入り、Failedではnull、Expired or Not Foundでは含まれません。

request_id
string<uuid>

Approved/Declinedの場合は、一致した認証のセッションIDで、POST /v3/email/send/が返すrequest_idと同一です。FailedおよびExpired or Not Foundの場合は、後から照会できないランダムな一回限りのUUIDです。

status
enum<string>

Approved:コードが正しく、却下となるリスクもありません。Declined:最終状態です。却下となるリスクに該当したか、試行回数の上限(3回)に達しました。Failed:コードが誤っており、試行回数が残っています。Expired or Not Found:直近5分以内に、このメールアドレスに対する保留中の認証がありません。

利用可能なオプション:
Approved,
Declined,
Failed,
Expired or Not Found
message
string

結果を人が読める形で説明したもの。誤ったコードが入力された後の残り試行回数を含みます。

email
object | null

メールの完全なレポート。最終的な結果(Approved/Declined)の場合にのみ存在し(null以外)、Failedの場合はnull、Expired or Not Foundの場合は含まれません。

vendor_data
string | null

一致した認証のセッションのvendor_dataです。Expired or Not Foundの場合はnullです。

metadata
object | null

一致した認証のセッションのmetadata。Expired or Not Foundの場合はnull。

created_at
string<date-time>

このチェックレスポンスの日時。

最終更新日 2026年11月1日