メインコンテンツへスキップ
GET
/
v1
メール検証API
curl --request GET \
  --url https://emailvalidation.cleariflow.com/v1
{
  "email": "jane.doe@acme-corp.com",
  "autocorrect": "",
  "deliverability": "DELIVERABLE",
  "quality_score": 0.85,
  "is_valid_format": {
    "value": true,
    "text": "TRUE"
  },
  "is_free_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_disposable_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_role_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_catchall_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_mx_found": {
    "value": true,
    "text": "TRUE"
  },
  "is_smtp_valid": {
    "value": true,
    "text": "TRUE"
  }
}

​
クイックスタート

リクエストを行うには、固有の api_key と確認したい email を指定するだけで十分です。他に必要なパラメータはありません。 
https://emailvalidation.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& email = jane.doe@acme-corp.com
リクエストが成功すると、アドレスに関する利用可能なすべてのインサイトが返されます。 
{
  "email": "jane.doe@acme-corp.com",
  "autocorrect": "",
  "deliverability": "DELIVERABLE",
  "quality_score": 0.85,
  "is_valid_format": {
    "value": true,
    "text": "TRUE"
  },
  "is_free_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_disposable_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_role_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_catchall_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_mx_found": {
    "value": true,
    "text": "TRUE"
  },
  "is_smtp_valid": {
    "value": true,
    "text": "TRUE"
  }
}

​
リクエストパラメータ

​
api_key
string
必須
個人のAPI認証情報です。キーはCleariflow製品ごとにスコープが分かれているため、メール検証のキーではIPジオロケーションAPIなど他のAPIへのリクエストは認可されません。
​
email
String
必須
検証したいメールアドレスです。
​
auto_correct
Boolean
自動修正を無効にするオプションフラグです。auto_correct=false を設定するとオフになります。デフォルトでは有効です。

​
レスポンスパラメータ

レスポンスは、コンパクトで標準化された JSON 形式で返されます。
​
email
String
リクエストで送信された email をエコーします。
​
auto_correct
String
タイプミスの可能性が検出された場合の修正候補です（例：johnsmith@gmial.com => johnsmith@gmail.com）。候補がない場合は空です。
​
deliverability
String
アドレスがメールを受信できるかどうかのCleariflowの評価です。取り得る値：DELIVERABLE、UNDELIVERABLE、UNKNOWN。有料プランでは DELIVERABLE には SMTP 検証の成功が必要です。MX レコードはあるが SMTP でメールボックスを確認できない場合（大手プロバイダでよくある）は UNKNOWN になります。無料プランでは、形式が無効または使い捨てドメインでない限り UNKNOWN です。
​
quality_score
Float
アドレス品質を示す 0〜0.99 の小数スコアです。使い捨てアドレスは約 0.05 に制限され、SMTP 未確認時は最大 0.55 です。
​
is_valid_format
Boolean
アドレスが標準パターン local@domain.tld に一致する場合に true です。要素の欠落や無効な文字がある場合は false になります。
​
is_free_email
Boolean
ドメインが無料メールプロバイダー（Gmail、Yahooなど）に属する場合に true です。
​
is_disposable_email
Boolean
ドメインが使い捨て・一時的な受信箱プロバイダーのリスト（Mailinator、Yopmailなど）に含まれる場合に true です。
​
is_role_email
Boolean
ローカル部が個人ではなく役割アカウント（team@、sales@、info@ など）と思われる場合に true です。
​
is_catchall_email
Boolean
ドメインが キャッチオール として設定されている場合に true です。有料プランでのみ利用可能。無料プランでは null/UNKNOWN を返します。
​
is_mx_found
Boolean
ドメインに MXレコード が存在する場合に true です。有料プランでのみ利用可能。無料プランでは null/UNKNOWN を返します。
​
is_smtp_valid
Boolean
SMTP 検証が成功した場合に true です。SMTPが失敗しても他のチェックが通過した場合、結果は UNKNOWN になることがあります。SMTPの失敗のみを理由にサインアップやフォーム送信をブロックすることは推奨しません。有料プランでのみ利用可能。無料プランでは null/UNKNOWN を返します。

​
リクエスト例

​
例：タイプミスの可能性

この例では、送信されたアドレスにタイプミスの可能性が検出されたリクエストを示します。 タイプミスの可能性が見つかった場合でも、他のすべてのチェック（無料メール、使い捨てドメインなど）は、修正候補ではなく元のアドレスに対して実行されます。 
https://emailvalidation.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& email = johnsmith@gmial.con
成功時のレスポンスは次のとおりです。 
{
  "email": "johnsmith@gmial.con",
  "autocorrect": "johnsmith@gmail.com",
  "deliverability": "UNKNOWN",
  "quality_score": 0.4,
  "is_valid_format": {
    "value": true,
    "text": "TRUE"
  },
  "is_free_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_disposable_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_role_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_catchall_email": {
    "value": null,
    "text": "UNKNOWN"
  },
  "is_mx_found": {
    "value": null,
    "text": "UNKNOWN"
  },
  "is_smtp_valid": {
    "value": null,
    "text": "UNKNOWN"
  }
}

​
例：無効なフォーマット

この例では、基本的なフォーマットチェックに失敗するアドレスを示します。is_valid_format が false の場合、後続のチェック（is_free_email、is_role_email など）はスキップされ、false として報告されます。 
https://emailvalidation.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& email = johnsmith
成功時のレスポンスは次のとおりです。 
{
  "email": "johnsmith",
  "autocorrect": "",
  "deliverability": "UNDELIVERABLE",
  "quality_score": 0.0,
  "is_valid_format": {
    "value": false,
    "text": "FALSE"
  },
  "is_free_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_disposable_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_role_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_catchall_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_mx_found": {
    "value": false,
    "text": "FALSE"
  },
  "is_smtp_valid": {
    "value": false,
    "text": "FALSE"
  }
}

​
一括アップロード（CSV）

APIを直接呼び出したくない場合は、CSV一括アップローダーをご利用ください。処理が完了すると結果がメールで送信されます。 CSVをアップロードする際は、次のガイドラインに従ってください。
  • メールアドレスを最初の列に配置してください。
  • 空行を削除してください。
  • 1行に1アドレスのみ記載してください。
  • ファイルは最大50,000行までに制限してください。

​
レスポンスおよびエラーコード

エラーはコードと人間が読める説明を含むJSON形式で返されます。一般的なコードを以下に示します。
CodeTypeDetails
200OKリクエストが正常に完了しました。
400Bad requestリクエストの形式が不正、または無効です。
401Unauthorized認証に失敗しました。通常はAPIキーが欠落しているか無効です。
422Quota reachedクォータを使い切りました（無料プランでクレジット不足など）。
429Too many requestsレート制限を超えました（無料プランでは1秒あたり最大1リクエスト）。
500Internal server errorサーバー側で予期しないエラーが発生しました。
503Service unavailableサービスが一時的に利用できません。

​
その他の注意事項

課金に関する注意：評価したメールアドレスごとに、結果に関わらず1リクエストあたり1クレジットを消費します。無効なアドレス（例：「fda3346ds」）を送信した場合でも1クレジットとしてカウントされます。