API ドキュメント

クイックスタート

ダッシュボードで API キーを作成し、サーバー側で安全に保管して Bearer 認証情報として送信します。受理された検証リクエストごとに1クレジットを消費します。

リクエスト

curl -sS -X POST 'https://api.verifyemail.net/api/v1/verifications' \
  -H 'Authorization: Bearer ve_live_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{"address":"[email protected]"}'

レスポンス · HTTP 200

{
  "errcode": 0,
  "address": "[email protected]",
  "is_deliverable": true,
  "status": 250,
  "catch_all": false,
  "disposable": false
}

認証

ダッシュボードで API キーを作成します：ダッシュボード → API キー

完全な ve_live_… の値は一度だけ表示されます。

API キーはサーバー側のシークレットとして保管してください。ブラウザーコード、URL パラメーター、公開リポジトリ、クライアントから見えるログには含めないでください。

Authorization: Bearer ve_live_your_api_key

メールアドレスを検証

POST/verifications

リクエスト本文

フィールド	型	必須	説明
address	string	はい	完全なメールアドレス。

レスポンスフィールド

フィールド	型	説明
errcode	number	0 は成功を示します。その他の値はエラー表に従って処理してください。
address	string	正規化されたメールアドレス。
is_deliverable	boolean	受信サーバーが受信者を受け入れるかどうか。
status	number \| null	SMTP の数値応答コード。SMTP 応答を受信できなかった場合は null。
catch_all	boolean \| null	ドメインが任意の受信者を受け入れるか。信頼できる結論がない場合は null。
disposable	boolean	アドレスが一時メールドメインに属するか。

250 · HTTP 200 · errcode 0

受信サーバーが受信者を受け入れました。

550 · HTTP 200 · errcode 0

ドメインまたは受信サーバーが受信者を拒否しました。

null · HTTP 422

アドレスが無効、または検証できません。

null · HTTP 503

信頼できる結論が得られません。後でもう一度お試しください。

以下の GET エンドポイントも利用できます。アドレスがプロキシログやブラウザー履歴に残らないよう、POST を推奨します： /verifications?address=…

残りクレジットを確認

GET/usage

このリクエストは検証クレジットを消費しません。同じユーザーのダッシュボードセッションとすべての API キーは同じ残高を共有します。

リクエスト

curl -sS 'https://api.verifyemail.net/api/v1/usage' \
  -H 'Authorization: Bearer ve_live_your_api_key'

レスポンス · HTTP 200

{
  "errcode": 0,
  "verification_limit": 100,
  "verification_used": 1,
  "remaining_verifications": 99,
  "unlimited": false
}

フィールド	型	説明
verification_limit	number	現在の合計上限。0 は無制限を意味します。
verification_used	number	すでに使用した検証クレジット数。
remaining_verifications	number \| null	利用可能な残りクレジット。無制限の場合は null。
unlimited	boolean	現在の上限が無制限かどうか。

無制限プランでは remaining_verifications: null, unlimited: true.

エラーコード

プログラムの判定には数値の errcode を使用してください。表示用の message は変更される場合があります。

エラーレスポンス

{
  "errcode": 10006,
  "message": "request rate limit exceeded"
}

errcode	HTTP	意味
0	2xx	リクエスト成功。
10000	400	リクエスト形式が不正です。JSON、ヘッダー、HTTP メソッドを確認してください。
10001	400 / 422	パラメーターまたはビジネスルールの検証に失敗しました。
10002	401	認証情報がない、無効、または期限切れです。
10003	403	このアカウントにはリソースへのアクセス権がありません。
10004	404	要求されたリソースが存在しません。
10005	409	リソースが現在の状態と競合しています。
10006	429	1秒あたりのリクエスト上限を超えました。
10007	429	検証クレジットを使い切りました。
10008	429	サービスの同時実行容量が上限に達しました。
10009	500	サービス内部エラーが発生しました。
10010	503	サービスが一時的に利用できないか、未設定です。
10011	502	上流サービスがエラーを返しました。

レート制限ヘッダー

Retry-After, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset — 現在のリクエストウィンドウを示します。

最初のリクエストを送信しますか？アカウントを作成すると、100回分の検証クレジットを利用できます。