Validation API

API change history

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

GetListValidationStatus

Returns email list validation status, and upon successful completion other useful statistics.

Try it

Request

Request URL

Request parameters

  • integer

    RequestId value received as response of list validation API call

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".

Request body

Responses

200 OK

Returns the current status of the ValidateEmailList request.

Based on processing status of the request,, different information is provided.

When processing status is "starting", the following information is provided:

  • RequestId (integer) - The identifier for this ValidateEmailList request.
  • Status (string) - Status of the ValidateEmailList request.
  • IsSuccessful (boolean) - Indicator of success of current API call.
  • Message (string) - Additional information in case of failed API call.

When processing status is "processing", the following information is provided:

  • RequestId (integer) - The identifier for this ValidateEmailList request.
  • Status (string) - Status of the ValidateEmailList request.
  • IsSuccessful (boolean) - Indicator of success of current API call.
  • Message (string) - Additional information in case of failed API call.
  • TotalAddresses (integer) - Total number of email addresses sent for validation.
  • TotalDeliverable (integer) - How many email addresses can be delivered to.
  • TotalUndeliverable (integer) - How many email addresses can not be delivered to.
  • TotalRisky (integer) - Number of email addresses with quality issues that may make it a risky or low-value address.
  • TotalUnknown (integer) - Total number of email addresses with unknown validation status.
  • TotalUnprocessed (integer) - Total number of unprocessed email addresses.

When processing status is "completed", the following information is provided:

  • RequestId (integer) - The identifier for this ValidateEmailList request.
  • Name (string) - The name of the validation list batch.
  • ReportId (string) - The identifier of report, that is to be provided as input argument to DownloadValidationResult api call, when complete report is to be downloaded.
  • Date (date) - Processing date.
  • ErrorMessage (string) - Error message returned for email list sent for validation.
  • Status (string) - Status of the ValidateEmailList request.
  • TotalAddresses (integer) - Total number of email addresses sent for validation.
  • TotalDeliverable (integer) - How many email addresses can be delivered to.
  • TotalUndeliverable (integer) - How many email addresses can not be delivered to.
  • TotalRisky (integer) - Number of email addresses with quality issues that may make it a risky or low-value address.
  • TotalUnknown (integer) - Total number of email addresses with unknown validation status.
  • QualityScore (float) - Average quality score for email list sent for validation.
  • Duration (integer) - Time taken to validate list of email addresses sent (in seconds).
  • Message (string) - Additional information in case of failed API call.
  • IsSuccessful (boolean) - Indicator of success of current API call.

When processing status is "failed", the following information is provided:

  • RequestId (integer) - The identifier for this ValidateEmailList request.
  • Status (string) - Status of the ValidateEmailList request.
  • IsSuccessful (boolean) - Indicator of success of current API call.
  • Message (string) - Additional information in case of failed API call.
  • Name (string) - The name of the validation list batch.
  • Date (date) - Processing date.
  • ErrorMessage (string) - Error message returned for email list sent for validation.
  • Duration (integer) - Time taken to validate list of email addresses sent (in seconds).

Representations

{
  "RequestId": 123,
  "Status": "failed",
  "IsSuccessful": true,
  "Message": null,
  "Name": "Batch API Process - 01-01-2019-00-00-00",
  "Date": "2019-01-01T12:00:00Z",
  "ErrorMessage": "Error description...",
  "Duration": 10
}
{
  "type": "object",
  "properties": {
    "RequestId": {
      "type": "integer"
    },
    "Status": {
      "type": "string"
    },
    "IsSuccessful": {
      "type": "boolean"
    },
    "Message": {
      "type": "string"
    }
  }
}

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

There is not enough credits on your account or your account has been suspended. Please check with your account representative for more information.

Representations

{
  "status": 403,
  "message": "Not enough credits in this 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/GetListValidationStatus?RequestId={RequestId}"
-H "Authorization: Bearer API_KEY"

--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");

            var uri = "https://api.touchbasepro.com/validate/GetListValidationStatus?RequestId={RequestId}&" + 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/GetListValidationStatus?RequestId={RequestId}");


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


            // 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/GetListValidationStatus?RequestId={RequestId}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","Bearer API_KEY");
            },
            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/GetListValidationStatus?RequestId={RequestId}";
    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 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/GetListValidationStatus?RequestId={RequestId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => 'Bearer API_KEY',
);

$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',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.touchbasepro.com')
    conn.request("GET", "/validate/GetListValidationStatus?RequestId={RequestId}&%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',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.touchbasepro.com')
    conn.request("GET", "/validate/GetListValidationStatus?RequestId={RequestId}&%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/GetListValidationStatus?RequestId={RequestId}')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = 'Bearer API_KEY'
# 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