Github Code Examples
For the latest updates regarding our API code examples please view our Gist at GitHub.
QUICK START GUIDE [V3 API]
The V3 API is our latest API release. It requires a license key or an authorised domain. Should you require our old documentation for any reason please navigate to our API Documentation V1. This quick start guide has been designed to get you up and running with our real-time email verification API solution as fast as possible. Please follow the steps below in sequence: Create Account Create your account by clicking here. Login Login to your customer portal to retrieve your API License Key. Try it Insert your license key into the following URL: API access using key The value for [FORMAT] below can be specified as either JSON, JSONP or XML. It is not case sensitive. https://api.emailverifyapi.API DOCUMENTATION V3
The URL to pass to the API is: https://api.emailverifyapi.com/v3/lookups/[FORMAT]?email=[EMAIL]&key=[YOUR_API_KEY]Parameter | Value | Mandatory or Optional |
---|---|---|
format | json, jsonp or xml | Mandatory |
the email address to be validated | Mandatory | |
key | your unique API key | Mandatory unless your domain has been whitelisted |
correct | 0 or 1 | Optional - 1 enables the typo correction feature |
# should be encoded as %23 * should be encoded as %2A & should be encoded as %26API Credits Exhausted Should your API credits be exhausted, you will receive the message “Rate limit exceeded – If you’d like a higher request volume please contact sales@emailchecker.com” Validation Results The API V3 validation results are presented using a different set of fields to that of V1. As mentioned previously, the real-time API V3 has the ability to output the validation result in different formats – JSON, JSONP and XML. The responses in each format would appear as follows: JSON Format JSONP Format XML Format Click the “View Raw” link in the XML Format Gist above to see the full XML tree. The fields and values in the results are the same whether encoded as JSON, JSONP or XML. They are simply formatted in a different output for your preference of real-time API client.
API RESPONSES
The table below details the main API responses from the Email Checker V3 API.Response | Return Code(s) or Value(s) | Explanation |
---|---|---|
address | Email address | Validates the email address that has been verified |
username | username | The username part of the email address before the @ |
domain | domain name | The domain name part of the email address after the @ |
md5Hash | md5 hash value | A unique MD5 hash value computed from the email address |
suggestion | Email address | A suggestion for emails with suspected typos |
validFormat | true or false | Whether the email address was in a valid RFC format |
deliverable | true or false | If we are able to deliver to the email address |
fullInbox | true or false | Whether the destination Inbox was full and therefore rejecting messages |
hostExists | true or false | If the destination mail server exists |
catchAll | true or false | The domain for the email address will accept any username part before the @, therefore it cannot be validated |
gravatar | false — Always return false at the moment | If there is a gravatar.com avatar configured for the email address |
role | Email address | The email address is a default "role" - see next table below |
disposable | true or false | Email is a known disposable, typically quick-turnaround addresses that are disposed of quickly |
free | true or false | Email address is from a "free" provider such as hotmail, outlook, gmail |