OpenAPI

Below is the OpenAPI specification of Reacher's API endpoints.

/check_email

Perform a full verification of an email address.

POSThttps://api.reacher.email/v0/check_email

Header parameters

Body

application/json

Input containing all parameters necessary for an email verification.

from_emailstring

In the SMTP connection, the FROM email address.

to_email*string

The email address to check.

hello_namestring

In the SMTP connection, the EHLO hostname.

proxyCheckEmailInputProxy

Proxy information for email verification.

smtp_portnumber

SMTP port to use for email validation. Generally, ports 25, 465, 587 and 2525 are used.

yahoo_verif_methodYahooVerifMethod

An enum to describe how we verify Yahoo emails.

ApiHeadlessSmtp

gmail_verif_methodGmailVerifMethod

An enum to describe how we verify Gmail emails.

ApiSmtp

hotmail_verif_methodHotmailVerifMethod

An enum to describe how we verify Hotmail emails.

ApiHeadlessSmtp

check_gravatarboolean

Whether to check if a gravatar image is existing for the given email.

retriesnumber

Number of retries of SMTP connections to do.

smtp_securityenum

How to apply TLS to a SMTP client connection.

Example: "Opportunistic"

NoneOpportunisticRequiredWrapper

smtp_timeoutDuration

An object representing a duration (seconds + nanoseconds).

Response

200

OK

Body

application/json

input*string (email)

The input email address.

is_reachable*Reachable

An enum to describe how confident we are that the recipient address is real: safe, risky, invalid and unknown. Check our docs to know the meanings of the 4 possibilities: https://docs.reacher.email/getting-started/publish-your-docs.

invalidunknownsaferisky

misc*one of

Miscellaneous information about the email account.

MiscDetailsError

mx*one of

Information gathered from querying the MX records of the mail server.

MxDetailsError

smtp*one of

Verifications performed by connecting to the mail server via SMTP.

SmtpDetailsError

syntax*SyntaxDetails

Syntax validation of an email address.

debugDebugDetails

Request

JavaScriptCurlPython

const response = await fetch('https://api.reacher.email/v0/check_email', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "to_email": "text"
    }),
});
const data = await response.json();

Response

200

{
  "input": "[e-mail]",
  "is_reachable": "invalid",
  "misc": {
    "is_disposable": false,
    "is_role_account": false,
    "gravatar_url": "text"
  },
  "mx": {
    "accepts_mail": false,
    "records": [
      "text"
    ]
  },
  "smtp": {
    "can_connect_smtp": false,
    "has_full_inbox": false,
    "is_catch_all": false,
    "is_deliverable": false,
    "is_disabled": false
  },
  "syntax": {
    "domain": "text",
    "is_valid_syntax": false,
    "username": "text"
  },
  "debug": {
    "start_time": "text",
    "end_time": "text",
    "duration": {
      "secs": 0,
      "nanos": 0
    },
    "server_name": "text",
    "smtp": {
      "verif_method": {
        "type": "Smtp",
        "host": "text",
        "port": 0
      }
    }
  }
}