Validation API

API change history

The Validation API allows users to validate on or more email addresses.

ValidateEmailAddress

Validates a single email address. This API analyzes the email address and returns information on the quality of the address. The information returned includes the emails value (aka - how likely is it to belong to a person), what role it plays, and other factors that help the user determine if the email is useful as a contact or should be passed over for more valuable targets.

Validating an email address helps the user verify that the address is to a real person, detect possible errors, and the level of "quality" of the email address (for example - [email protected] is a better email address than [email protected]).

Try it

Request

Request URL

Request parameters

  • string

    The email address to be validated, as a URL-encoded string.

Request headers

  • string

    The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

  • (optional)
    string

    The Webhook URL

Request body

Responses

200 OK

Returns an application/json object in the response body. The fields return include:

  1. Result (string) - The verification result. Values include:
  • deliverable
  • undeliverable
  • risky
  • unknown
  1. Reason (string) - The reason for the result. Possible reasons are:
  • invalid_email - Specified email is not a valid email address syntax
  • invalid_domain - Domain for email does not exist
  • rejected_email - Email address was rejected by the SMTP server, email address does not exist
  • accepted_email - Email address was accepted by the SMTP server
  • low_quality - Email address has quality issues that may make it a risky or low-value address
  • low_deliverability - Email address appears to be deliverable, but deliverability cannot be guaranteed
  • no_connect - Could not connect to SMTP server
  • timeout - SMTP session timed out
  • invalid_smtp - SMTP server returned an unexpected/invalid response
  • unavailable_smtp - SMTP server was unavailable to process our request
  • unexpected_error - An unexpected error has occurred
  1. IsRole (boolean) - true if the email address is a role address ([email protected], [email protected], etc)
  2. IsFree (boolean) - true if the email address uses a free email service like gmail.com or yahoo.com.
  3. IsDisposable (boolean) - true if the email address uses a disposable domain like trashmail.com or mailinator.com.
  4. AcceptAll (boolean) - true if the email was accepted, but the domain appears to accept all emails addressed to that domain.
  5. DidYouMean (string) - Returns a suggested email if a possible spelling error was detected. ([email protected] -> [email protected])
  6. QualityScore (float) - A quality score of the provided email address ranging between 0 (no quality) and 1 (perfect quality)
  7. Email (string) - Returns a normalized version of the provided email address. ([email protected] -> [email protected])
  8. User (string) - The user (a.k.a local part) of the provided email address. ([email protected] -> bob)
  9. Domain (string) - The domain of the provided email address. ([email protected] -> example.com)
  10. IsSuccess (boolean) - true if the API request was successful (i.e., no authentication or unexpected errors occurred)

Representations

{
  "Result": "risky",
  "Reason": "low_deliverability",
  "IsRole": false,
  "IsFree": false,
  "IsDisposable": false,
  "AcceptAll": true,
  "DidYouMean": null,
  "QualityScore": 0.71,
  "Email": "[email protected]",
  "User": "atom.ant",
  "Domain": "touchbasepro.com",
  "IsSuccess": true,
  "Message": null
}
{
  "type": "object",
  "properties": {
    "Result": {
      "type": "string"
    },
    "Reason": {
      "type": "string"
    },
    "IsRole": {
      "type": "boolean"
    },
    "IsFree": {
      "type": "boolean"
    },
    "IsDisposable": {
      "type": "boolean"
    },
    "AcceptAll": {
      "type": "boolean"
    },
    "DidYouMean": {
      "type": "string"
    },
    "QualityScore": {
      "type": "number"
    },
    "Email": {
      "type": "string"
    },
    "User": {
      "type": "string"
    },
    "Domain": {
      "type": "string"
    },
    "IsSuccess": {
      "type": "boolean"
    },
    "Message": {
      "type": "string"
    }
  }
}

400 Bad Request

The request was not properly formatted. The email address must be URL encoded.

Representations

Email address was not valid.

401 Unauthorized

The API key is invalid. Please verify it is correct and try again.

Representations

{
  "status": 401,
  "message": "API key is invalid."
}

403 Forbidden

Your account has been suspended! Please check with your account representative for more information.

Representations

{
  "status": 403,
  "message": "Your account has been suspended! Please check with your account representative for more information."
}

405 Method Not Allowed

There is not enough credits on your account

Representations

{
  "status": 405,
  "message": "There's not enough credits on your account!"
}

429 Too many requests

The number of API calls has been exceeded. The return will include the number of seconds (represented by (number of seconds) in the example) until the API call can be tried again.

Representations

{
  "status": 429,
  "message": "Rate limit is exceeded.  Try again in {number of seconds} seconds."
}

500 Internal Server Error

Some error occurred in the processing request. Please try it again at a later time.

Representations

{
  "status": 500,
  "message": "An internal error has occurred. We have been notified about it and\nwill restore service functionality as soon as possible."
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.touchbasepro.com/validate/ValidateEmailAddress?email={email}"
-H "Authorization: Bearer API_KEY"
-H "X-TBP-Webhook: "

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Authorization", "Bearer API_KEY");
            client.DefaultRequestHeaders.Add("X-TBP-Webhook", "");

            var uri = "https://api.touchbasepro.com/validate/ValidateEmailAddress?email={email}&" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.touchbasepro.com/validate/ValidateEmailAddress?email={email}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Authorization", "Bearer API_KEY");
            request.setHeader("X-TBP-Webhook", "");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.touchbasepro.com/validate/ValidateEmailAddress?email={email}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","Bearer API_KEY");
                xhrObj.setRequestHeader("X-TBP-Webhook","");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.touchbasepro.com/validate/ValidateEmailAddress?email={email}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"Bearer API_KEY" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"" forHTTPHeaderField:@"X-TBP-Webhook"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.touchbasepro.com/validate/ValidateEmailAddress?email={email}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => 'Bearer API_KEY',
    'X-TBP-Webhook' => '',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Authorization': 'Bearer API_KEY',
    'X-TBP-Webhook': '',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.touchbasepro.com')
    conn.request("GET", "/validate/ValidateEmailAddress?email={email}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Authorization': 'Bearer API_KEY',
    'X-TBP-Webhook': '',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.touchbasepro.com')
    conn.request("GET", "/validate/ValidateEmailAddress?email={email}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.touchbasepro.com/validate/ValidateEmailAddress?email={email}')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = 'Bearer API_KEY'
# Request headers
request['X-TBP-Webhook'] = ''
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body