v1

latestSwagger 2.02026-07-132830204.5 KB
Security and Networking

Email Verify

SMTP based email address verification

get/email-verify

Query parameters

emailstring required

An email address

fix-typosboolean

Automatically attempt to fix typos in the address

Response

OK

validboolean required

Is this a valid email address. To be valid an email must have: correct syntax, a registered and active domain name, correct DNS records and operational MX servers

verifiedboolean required

True if this email address has passed SMTP username verification. Check the 'smtp-status' and 'domain-status' fields for specific verification details

emailstring required

The complete email address. If you enabled the 'fix-typos' option then this will be the corrected address

typos-fixedboolean required

True if any typos have been fixed. The 'fix-typos' option must be enabled for this to work

syntax-errorboolean required

True if this address has any syntax errors or is not in RFC compliant formatting

domain-errorboolean required

True if this address has any domain name or DNS related errors. Check the 'domain-status' field for the detailed error reason

domainstring required

The domain name of this email address

providerstring required

The domain name of the email hosting provider

is-freemailboolean required

True if this address is from a free email provider

is-disposableboolean required

True if this address is a disposable, temporary or darknet related email address

is-personalboolean required

True if this address likely belongs to a person. False if this is a role based address, e.g. admin@, help@, office@, etc.

smtp-statusstring required

The SMTP username verification status for this address: <br> <ul> <li>ok - verification was successful, this is a real username that can receive mail</li> <li>absent - this username or domain is not registered with the email service provider</li> <li>invalid - not a valid email address, check the 'domain-status' field for specific details</li> <li>unresponsive - the mail servers for this domain have repeatedly timed-out or refused multiple connection attempts</li> <li>unknown - sorry, we could not reliably determine the status of this username</li> </ul>

smtp-responsestring required

The raw SMTP response message received during verification

is-catch-allboolean required

True if this email domain has a catch-all policy. A catch-all domain will accept mail for any username so therefor the 'smtp-status' will always be 'ok'

is-deferredboolean required

True if the mail server responded with a temporary failure (either a 4xx response code or unresponsive server). You can retry this address later, we recommend waiting at least 15 minutes before retrying

mx-ipstring required

The first resolved IP address of the primary MX server, may be empty if there are domain errors present

domain-statusstring required

The email domain status, possible values are: <br> <ul> <li>ok - the domain is in working order and can receive email</li> <li>invalid - the domain is not a conformant hostname. May contain invalid syntax or characters</li> <li>no-service - the domain owner has indicated there is no mail service on the domain (also known as the 'Null MX')</li> <li>no-mail - the domain has no valid MX records so cannot receive email</li> <li>mx-invalid - MX records contain invalid or non-conformant hostname values</li> <li>mx-bogon - MX records point to bogon IP addresses</li> <li>resolv-error - MX records do not resolve to any valid IP addresses</li> </ul>

Example response

{
  "domain": "neutrinoapi.com",
  "domain-error": false,
  "domain-status": "ok",
  "email": "tech@neutrinoapi.com",
  "is-catch-all": false,
  "is-deferred": false,
  "is-disposable": false,
  "is-freemail": false,
  "is-personal": false,
  "mx-ip": "111.65.230.109",
  "provider": "isx.net.nz",
  "smtp-response": "250 Accepted",
  "smtp-status": "ok",
  "syntax-error": false,
  "typos-fixed": false,
  "valid": true,
  "verified": true
}