Integrated Marketing Datacenter API

AddressHygiene

addressStart

start job

- PCOA - NCOA - Telephone Append (including wireless) - Email Append (including real-time verification) Provide an address and have it enriched with email append, phone append, national and propretary change of address enhancements as well. National Change of Address Processing (NCOALink), is provided by a non-exclusive licensee of the United States Postal Service. IMDataCenter’s NCOA goes back 48 months and the process includes Delivery Point Validation (DPV) and Locatable Address Conversion System (LACS, which converts a rural route to a street address). NCOA is a great way to make sure an address is valid and also update moves for anyone who has filled out a change of address card with the post office. NCOA is required to be run every 90 days for certain postal discounts. Proprietary Change of Address (PCOA) Processing goes back 35 years including historical move information sourced from proprietary sources. Where NCOA is very comparable between vendors our PCOA process stands above most providers based on the number of sources we leverage. If you would like a free analysis please contact us today and we will run a comparison. In addition to updating the postal address with PCOA or NCOA new phones or email addresses can be appended in real-time. New phone numbers types include Landline, Wireless, Voice Over IP (VOIP) and/or Business Phone numbers normally resulting in a 65%+ match rate which can be confirmed with a free analysis on your file. Each month the balance of phone types tips more towards wireless phones verses landlines and we offer the capability to append only wireless numbers by setting wireless_only to true. Appended emails are a great way to stay in touch with prospects and client's. Typically 50% of records are matched to a historical email address and then validated in real-time to ensure deliverability and accuracy. If all 4 Address Hygiene (PCOA, NCOA, Telephone Append, Email Append) services are used in concert with one another a totally updating record with result from first tracking moves from USPS change of addresses and PCOA moves including historical moves going back 35 years and those not registered with the post offices. Once we have that updated record we can provide the most current phone number and validated email address for future follow up. This can be used to expedite call center registrations or automation of marketing tasks. If you have a question about any of the processing please do not hesitate to contact us as we can customize the solution to meet your needs.


/address

Usage and SDK Samples

curl -X POST -H "x-api-key: [[apiKey]]" "https://api.imdatacenter.com/1.0/address"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressHygieneApi;

import java.io.File;
import java.util.*;

public class AddressHygieneApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        AddressHygieneApi apiInstance = new AddressHygieneApi();
        Body body = ; // Body | Address information and job details
        try {
            inline_response_201 result = apiInstance.addressStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressHygieneApi#addressStart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressHygieneApi;

public class AddressHygieneApiExample {

    public static void main(String[] args) {
        AddressHygieneApi apiInstance = new AddressHygieneApi();
        Body body = ; // Body | Address information and job details
        try {
            inline_response_201 result = apiInstance.addressStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressHygieneApi#addressStart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

Body *body = ; // Address information and job details

AddressHygieneApi *apiInstance = [[AddressHygieneApi alloc] init];

// start job
[apiInstance addressStartWith:body
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');
var defaultClient = IntegratedMarketingDatacenterApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new IntegratedMarketingDatacenterApi.AddressHygieneApi()

var body = ; // {Body} Address information and job details


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addressStart(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addressStartExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new AddressHygieneApi();
            var body = new Body(); // Body | Address information and job details

            try
            {
                // start job
                inline_response_201 result = apiInstance.addressStart(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressHygieneApi.addressStart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\AddressHygieneApi();
$body = ; // Body | Address information and job details

try {
    $result = $api_instance->addressStart($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressHygieneApi->addressStart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressHygieneApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressHygieneApi->new();
my $body = WWW::SwaggerClient::Object::Body->new(); # Body | Address information and job details

eval { 
    my $result = $api_instance->addressStart(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressHygieneApi->addressStart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressHygieneApi()
body =  # Body | Address information and job details

try: 
    # start job
    api_response = api_instance.address_start(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressHygieneApi->addressStart: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Job started

Status: 400 - Invalid input


addressStatus

get results

Retrieve the results from a previously started /address job.


/address/{jobId}

Usage and SDK Samples

curl -X GET "https://api.imdatacenter.com/1.0/address/{jobId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressHygieneApi;

import java.io.File;
import java.util.*;

public class AddressHygieneApiExample {

    public static void main(String[] args) {
        
        AddressHygieneApi apiInstance = new AddressHygieneApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200 result = apiInstance.addressStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressHygieneApi#addressStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressHygieneApi;

public class AddressHygieneApiExample {

    public static void main(String[] args) {
        AddressHygieneApi apiInstance = new AddressHygieneApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200 result = apiInstance.addressStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressHygieneApi#addressStatus");
            e.printStackTrace();
        }
    }
}
String *jobId = jobId_example; // The id value that was returned when the job was created.

AddressHygieneApi *apiInstance = [[AddressHygieneApi alloc] init];

// get results
[apiInstance addressStatusWith:jobId
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');

var api = new IntegratedMarketingDatacenterApi.AddressHygieneApi()

var jobId = jobId_example; // {String} The id value that was returned when the job was created.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addressStatus(jobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addressStatusExample
    {
        public void main()
        {
            
            var apiInstance = new AddressHygieneApi();
            var jobId = jobId_example;  // String | The id value that was returned when the job was created.

            try
            {
                // get results
                inline_response_200 result = apiInstance.addressStatus(jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressHygieneApi.addressStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AddressHygieneApi();
$jobId = jobId_example; // String | The id value that was returned when the job was created.

try {
    $result = $api_instance->addressStatus($jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressHygieneApi->addressStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressHygieneApi;

my $api_instance = WWW::SwaggerClient::AddressHygieneApi->new();
my $jobId = jobId_example; # String | The id value that was returned when the job was created.

eval { 
    my $result = $api_instance->addressStatus(jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressHygieneApi->addressStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AddressHygieneApi()
jobId = jobId_example # String | The id value that was returned when the job was created.

try: 
    # get results
    api_response = api_instance.address_status(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressHygieneApi->addressStatus: %s\n" % e)

Parameters

Path parameters
Name Description
jobId*
String
The id value that was returned when the job was created.
Required

Responses

Status: 200 - Successful Operation The result object returned contains

Status: 400 - Invalid job id supplied

Status: 404 - Job not found


Cima

cimaStart

start job

Complete Integrated Marketing Append takes any PII information you wish to provide and enhances it completely. Bad and incomplete data is welcome here, but know that the more information you provide, the better our match rate and enhancement will be. If you have a question about any of the processing please do not hesitate to contact us as we can customize the solution to meet your needs.


/cima

Usage and SDK Samples

curl -X POST -H "x-api-key: [[apiKey]]" "https://api.imdatacenter.com/1.0/cima"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CimaApi;

import java.io.File;
import java.util.*;

public class CimaApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        CimaApi apiInstance = new CimaApi();
        Body_4 body = ; // Body_4 | CIMA information and job details
        try {
            inline_response_201_1 result = apiInstance.cimaStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CimaApi#cimaStart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CimaApi;

public class CimaApiExample {

    public static void main(String[] args) {
        CimaApi apiInstance = new CimaApi();
        Body_4 body = ; // Body_4 | CIMA information and job details
        try {
            inline_response_201_1 result = apiInstance.cimaStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CimaApi#cimaStart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

Body_4 *body = ; // CIMA information and job details

CimaApi *apiInstance = [[CimaApi alloc] init];

// start job
[apiInstance cimaStartWith:body
              completionHandler: ^(inline_response_201_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');
var defaultClient = IntegratedMarketingDatacenterApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new IntegratedMarketingDatacenterApi.CimaApi()

var body = ; // {Body_4} CIMA information and job details


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cimaStart(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cimaStartExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new CimaApi();
            var body = new Body_4(); // Body_4 | CIMA information and job details

            try
            {
                // start job
                inline_response_201_1 result = apiInstance.cimaStart(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CimaApi.cimaStart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CimaApi();
$body = ; // Body_4 | CIMA information and job details

try {
    $result = $api_instance->cimaStart($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CimaApi->cimaStart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CimaApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CimaApi->new();
my $body = WWW::SwaggerClient::Object::Body_4->new(); # Body_4 | CIMA information and job details

eval { 
    my $result = $api_instance->cimaStart(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CimaApi->cimaStart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CimaApi()
body =  # Body_4 | CIMA information and job details

try: 
    # start job
    api_response = api_instance.cima_start(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CimaApi->cimaStart: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Job started

Status: 400 - Invalid input


cimaStatus

get results

Retrieve the results from a previously started /cima job.


/cima/{jobId}

Usage and SDK Samples

curl -X GET "https://api.imdatacenter.com/1.0/cima/{jobId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CimaApi;

import java.io.File;
import java.util.*;

public class CimaApiExample {

    public static void main(String[] args) {
        
        CimaApi apiInstance = new CimaApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200_4 result = apiInstance.cimaStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CimaApi#cimaStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CimaApi;

public class CimaApiExample {

    public static void main(String[] args) {
        CimaApi apiInstance = new CimaApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200_4 result = apiInstance.cimaStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CimaApi#cimaStatus");
            e.printStackTrace();
        }
    }
}
String *jobId = jobId_example; // The id value that was returned when the job was created.

CimaApi *apiInstance = [[CimaApi alloc] init];

// get results
[apiInstance cimaStatusWith:jobId
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');

var api = new IntegratedMarketingDatacenterApi.CimaApi()

var jobId = jobId_example; // {String} The id value that was returned when the job was created.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cimaStatus(jobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cimaStatusExample
    {
        public void main()
        {
            
            var apiInstance = new CimaApi();
            var jobId = jobId_example;  // String | The id value that was returned when the job was created.

            try
            {
                // get results
                inline_response_200_4 result = apiInstance.cimaStatus(jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CimaApi.cimaStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CimaApi();
$jobId = jobId_example; // String | The id value that was returned when the job was created.

try {
    $result = $api_instance->cimaStatus($jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CimaApi->cimaStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CimaApi;

my $api_instance = WWW::SwaggerClient::CimaApi->new();
my $jobId = jobId_example; # String | The id value that was returned when the job was created.

eval { 
    my $result = $api_instance->cimaStatus(jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CimaApi->cimaStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CimaApi()
jobId = jobId_example # String | The id value that was returned when the job was created.

try: 
    # get results
    api_response = api_instance.cima_status(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CimaApi->cimaStatus: %s\n" % e)

Parameters

Path parameters
Name Description
jobId*
String
The id value that was returned when the job was created.
Required

Responses

Status: 200 - successful operation

Status: 400 - Invalid job id supplied

Status: 404 - Job not found


CimaCert

cimaCertStart

start job

CIMA Certify provides a mechanism for verifying consumer contact information, both for purposes of scoring and segmenting individuals, and for identifying and reducing potential fraud and risk.


/cima-cert

Usage and SDK Samples

curl -X POST -H "x-api-key: [[apiKey]]" "https://api.imdatacenter.com/1.0/cima-cert"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CimaCertApi;

import java.io.File;
import java.util.*;

public class CimaCertApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        CimaCertApi apiInstance = new CimaCertApi();
        Body_3 body = ; // Body_3 | CIMA Certify information and job details
        try {
            inline_response_201_1 result = apiInstance.cimaCertStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CimaCertApi#cimaCertStart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CimaCertApi;

public class CimaCertApiExample {

    public static void main(String[] args) {
        CimaCertApi apiInstance = new CimaCertApi();
        Body_3 body = ; // Body_3 | CIMA Certify information and job details
        try {
            inline_response_201_1 result = apiInstance.cimaCertStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CimaCertApi#cimaCertStart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

Body_3 *body = ; // CIMA Certify information and job details

CimaCertApi *apiInstance = [[CimaCertApi alloc] init];

// start job
[apiInstance cimaCertStartWith:body
              completionHandler: ^(inline_response_201_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');
var defaultClient = IntegratedMarketingDatacenterApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new IntegratedMarketingDatacenterApi.CimaCertApi()

var body = ; // {Body_3} CIMA Certify information and job details


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cimaCertStart(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cimaCertStartExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new CimaCertApi();
            var body = new Body_3(); // Body_3 | CIMA Certify information and job details

            try
            {
                // start job
                inline_response_201_1 result = apiInstance.cimaCertStart(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CimaCertApi.cimaCertStart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CimaCertApi();
$body = ; // Body_3 | CIMA Certify information and job details

try {
    $result = $api_instance->cimaCertStart($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CimaCertApi->cimaCertStart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CimaCertApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CimaCertApi->new();
my $body = WWW::SwaggerClient::Object::Body_3->new(); # Body_3 | CIMA Certify information and job details

eval { 
    my $result = $api_instance->cimaCertStart(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CimaCertApi->cimaCertStart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CimaCertApi()
body =  # Body_3 | CIMA Certify information and job details

try: 
    # start job
    api_response = api_instance.cima_cert_start(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CimaCertApi->cimaCertStart: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Job started

Status: 400 - Invalid input


cimaCertStatus

get results

Retrieve the results from a previously started /cima-cert job.


/cima-cert/{jobId}

Usage and SDK Samples

curl -X GET "https://api.imdatacenter.com/1.0/cima-cert/{jobId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CimaCertApi;

import java.io.File;
import java.util.*;

public class CimaCertApiExample {

    public static void main(String[] args) {
        
        CimaCertApi apiInstance = new CimaCertApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200_3 result = apiInstance.cimaCertStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CimaCertApi#cimaCertStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CimaCertApi;

public class CimaCertApiExample {

    public static void main(String[] args) {
        CimaCertApi apiInstance = new CimaCertApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200_3 result = apiInstance.cimaCertStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CimaCertApi#cimaCertStatus");
            e.printStackTrace();
        }
    }
}
String *jobId = jobId_example; // The id value that was returned when the job was created.

CimaCertApi *apiInstance = [[CimaCertApi alloc] init];

// get results
[apiInstance cimaCertStatusWith:jobId
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');

var api = new IntegratedMarketingDatacenterApi.CimaCertApi()

var jobId = jobId_example; // {String} The id value that was returned when the job was created.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cimaCertStatus(jobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cimaCertStatusExample
    {
        public void main()
        {
            
            var apiInstance = new CimaCertApi();
            var jobId = jobId_example;  // String | The id value that was returned when the job was created.

            try
            {
                // get results
                inline_response_200_3 result = apiInstance.cimaCertStatus(jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CimaCertApi.cimaCertStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CimaCertApi();
$jobId = jobId_example; // String | The id value that was returned when the job was created.

try {
    $result = $api_instance->cimaCertStatus($jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CimaCertApi->cimaCertStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CimaCertApi;

my $api_instance = WWW::SwaggerClient::CimaCertApi->new();
my $jobId = jobId_example; # String | The id value that was returned when the job was created.

eval { 
    my $result = $api_instance->cimaCertStatus(jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CimaCertApi->cimaCertStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CimaCertApi()
jobId = jobId_example # String | The id value that was returned when the job was created.

try: 
    # get results
    api_response = api_instance.cima_cert_status(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CimaCertApi->cimaCertStatus: %s\n" % e)

Parameters

Path parameters
Name Description
jobId*
String
The id value that was returned when the job was created.
Required

Responses

Status: 200 - successful operation

Status: 400 - Invalid job id supplied

Status: 404 - Job not found


CimaSelect

cimaSelectStart

start job

Complete Integrated Marketing Append Select takes any PII information you wish to provide and enhances it completely. Bad and incomplete data is welcome here, but know that the more information you provide, the better our match rate and enhancement will be. If you have a question about any of the processing please do not hesitate to contact us as we can customize the solution to meet your needs.


/cima-select

Usage and SDK Samples

curl -X POST -H "x-api-key: [[apiKey]]" "https://api.imdatacenter.com/1.0/cima-select"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CimaSelectApi;

import java.io.File;
import java.util.*;

public class CimaSelectApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        CimaSelectApi apiInstance = new CimaSelectApi();
        Body_5 body = ; // Body_5 | CIMA Select information and job details
        try {
            inline_response_201_1 result = apiInstance.cimaSelectStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CimaSelectApi#cimaSelectStart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CimaSelectApi;

public class CimaSelectApiExample {

    public static void main(String[] args) {
        CimaSelectApi apiInstance = new CimaSelectApi();
        Body_5 body = ; // Body_5 | CIMA Select information and job details
        try {
            inline_response_201_1 result = apiInstance.cimaSelectStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CimaSelectApi#cimaSelectStart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

Body_5 *body = ; // CIMA Select information and job details

CimaSelectApi *apiInstance = [[CimaSelectApi alloc] init];

// start job
[apiInstance cimaSelectStartWith:body
              completionHandler: ^(inline_response_201_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');
var defaultClient = IntegratedMarketingDatacenterApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new IntegratedMarketingDatacenterApi.CimaSelectApi()

var body = ; // {Body_5} CIMA Select information and job details


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cimaSelectStart(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cimaSelectStartExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new CimaSelectApi();
            var body = new Body_5(); // Body_5 | CIMA Select information and job details

            try
            {
                // start job
                inline_response_201_1 result = apiInstance.cimaSelectStart(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CimaSelectApi.cimaSelectStart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CimaSelectApi();
$body = ; // Body_5 | CIMA Select information and job details

try {
    $result = $api_instance->cimaSelectStart($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CimaSelectApi->cimaSelectStart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CimaSelectApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CimaSelectApi->new();
my $body = WWW::SwaggerClient::Object::Body_5->new(); # Body_5 | CIMA Select information and job details

eval { 
    my $result = $api_instance->cimaSelectStart(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CimaSelectApi->cimaSelectStart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CimaSelectApi()
body =  # Body_5 | CIMA Select information and job details

try: 
    # start job
    api_response = api_instance.cima_select_start(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CimaSelectApi->cimaSelectStart: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Job started

Status: 400 - Invalid input


cimaSelectStatus

get results

Retrieve the results from a previously started /cima-select job.


/cima-select/{jobId}

Usage and SDK Samples

curl -X GET "https://api.imdatacenter.com/1.0/cima-select/{jobId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CimaSelectApi;

import java.io.File;
import java.util.*;

public class CimaSelectApiExample {

    public static void main(String[] args) {
        
        CimaSelectApi apiInstance = new CimaSelectApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200_5 result = apiInstance.cimaSelectStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CimaSelectApi#cimaSelectStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CimaSelectApi;

public class CimaSelectApiExample {

    public static void main(String[] args) {
        CimaSelectApi apiInstance = new CimaSelectApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200_5 result = apiInstance.cimaSelectStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CimaSelectApi#cimaSelectStatus");
            e.printStackTrace();
        }
    }
}
String *jobId = jobId_example; // The id value that was returned when the job was created.

CimaSelectApi *apiInstance = [[CimaSelectApi alloc] init];

// get results
[apiInstance cimaSelectStatusWith:jobId
              completionHandler: ^(inline_response_200_5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');

var api = new IntegratedMarketingDatacenterApi.CimaSelectApi()

var jobId = jobId_example; // {String} The id value that was returned when the job was created.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cimaSelectStatus(jobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cimaSelectStatusExample
    {
        public void main()
        {
            
            var apiInstance = new CimaSelectApi();
            var jobId = jobId_example;  // String | The id value that was returned when the job was created.

            try
            {
                // get results
                inline_response_200_5 result = apiInstance.cimaSelectStatus(jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CimaSelectApi.cimaSelectStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CimaSelectApi();
$jobId = jobId_example; // String | The id value that was returned when the job was created.

try {
    $result = $api_instance->cimaSelectStatus($jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CimaSelectApi->cimaSelectStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CimaSelectApi;

my $api_instance = WWW::SwaggerClient::CimaSelectApi->new();
my $jobId = jobId_example; # String | The id value that was returned when the job was created.

eval { 
    my $result = $api_instance->cimaSelectStatus(jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CimaSelectApi->cimaSelectStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CimaSelectApi()
jobId = jobId_example # String | The id value that was returned when the job was created.

try: 
    # get results
    api_response = api_instance.cima_select_status(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CimaSelectApi->cimaSelectStatus: %s\n" % e)

Parameters

Path parameters
Name Description
jobId*
String
The id value that was returned when the job was created.
Required

Responses

Status: 200 - successful operation

Status: 400 - Invalid job id supplied

Status: 404 - Job not found


EmailVerification

emailVerificationStatus

get results

Retrieve the results from a previously started /verification job.


/verification/{jobId}

Usage and SDK Samples

curl -X GET "https://api.imdatacenter.com/1.0/verification/{jobId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EmailVerificationApi;

import java.io.File;
import java.util.*;

public class EmailVerificationApiExample {

    public static void main(String[] args) {
        
        EmailVerificationApi apiInstance = new EmailVerificationApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200_6 result = apiInstance.emailVerificationStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EmailVerificationApi#emailVerificationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EmailVerificationApi;

public class EmailVerificationApiExample {

    public static void main(String[] args) {
        EmailVerificationApi apiInstance = new EmailVerificationApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200_6 result = apiInstance.emailVerificationStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EmailVerificationApi#emailVerificationStatus");
            e.printStackTrace();
        }
    }
}
String *jobId = jobId_example; // The id value that was returned when the job was created.

EmailVerificationApi *apiInstance = [[EmailVerificationApi alloc] init];

// get results
[apiInstance emailVerificationStatusWith:jobId
              completionHandler: ^(inline_response_200_6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');

var api = new IntegratedMarketingDatacenterApi.EmailVerificationApi()

var jobId = jobId_example; // {String} The id value that was returned when the job was created.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.emailVerificationStatus(jobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class emailVerificationStatusExample
    {
        public void main()
        {
            
            var apiInstance = new EmailVerificationApi();
            var jobId = jobId_example;  // String | The id value that was returned when the job was created.

            try
            {
                // get results
                inline_response_200_6 result = apiInstance.emailVerificationStatus(jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailVerificationApi.emailVerificationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EmailVerificationApi();
$jobId = jobId_example; // String | The id value that was returned when the job was created.

try {
    $result = $api_instance->emailVerificationStatus($jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailVerificationApi->emailVerificationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EmailVerificationApi;

my $api_instance = WWW::SwaggerClient::EmailVerificationApi->new();
my $jobId = jobId_example; # String | The id value that was returned when the job was created.

eval { 
    my $result = $api_instance->emailVerificationStatus(jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EmailVerificationApi->emailVerificationStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EmailVerificationApi()
jobId = jobId_example # String | The id value that was returned when the job was created.

try: 
    # get results
    api_response = api_instance.email_verification_status(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailVerificationApi->emailVerificationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
jobId*
String
The id value that was returned when the job was created.
Required

Responses

Status: 200 - successful operation

Status: 400 - Bad request. A parameter was missing or has an invalid value.


ReverseEmailAppend

emailStart

start job

Reverse Email Append leverages our vast email database to match phone and address details with a given email address. The match rate is varies based on the target market and how the data is sourced. A free match analysis on your specific dataset is available upon request. If you have a question about any of the processing please do not hesitate to contact us as we can customize the solution to meet your needs.


/email

Usage and SDK Samples

curl -X POST -H "x-api-key: [[apiKey]]" "https://api.imdatacenter.com/1.0/email"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReverseEmailAppendApi;

import java.io.File;
import java.util.*;

public class ReverseEmailAppendApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ReverseEmailAppendApi apiInstance = new ReverseEmailAppendApi();
        Body_2 body = ; // Body_2 | Email information and job details
        try {
            inline_response_201_1 result = apiInstance.emailStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReverseEmailAppendApi#emailStart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReverseEmailAppendApi;

public class ReverseEmailAppendApiExample {

    public static void main(String[] args) {
        ReverseEmailAppendApi apiInstance = new ReverseEmailAppendApi();
        Body_2 body = ; // Body_2 | Email information and job details
        try {
            inline_response_201_1 result = apiInstance.emailStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReverseEmailAppendApi#emailStart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

Body_2 *body = ; // Email information and job details

ReverseEmailAppendApi *apiInstance = [[ReverseEmailAppendApi alloc] init];

// start job
[apiInstance emailStartWith:body
              completionHandler: ^(inline_response_201_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');
var defaultClient = IntegratedMarketingDatacenterApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new IntegratedMarketingDatacenterApi.ReverseEmailAppendApi()

var body = ; // {Body_2} Email information and job details


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.emailStart(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class emailStartExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new ReverseEmailAppendApi();
            var body = new Body_2(); // Body_2 | Email information and job details

            try
            {
                // start job
                inline_response_201_1 result = apiInstance.emailStart(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReverseEmailAppendApi.emailStart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\ReverseEmailAppendApi();
$body = ; // Body_2 | Email information and job details

try {
    $result = $api_instance->emailStart($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReverseEmailAppendApi->emailStart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReverseEmailAppendApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ReverseEmailAppendApi->new();
my $body = WWW::SwaggerClient::Object::Body_2->new(); # Body_2 | Email information and job details

eval { 
    my $result = $api_instance->emailStart(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReverseEmailAppendApi->emailStart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ReverseEmailAppendApi()
body =  # Body_2 | Email information and job details

try: 
    # start job
    api_response = api_instance.email_start(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReverseEmailAppendApi->emailStart: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Job started

Status: 400 - Invalid input


emailStatus

get results

Retrieve the results from a previously started /email job.


/email/{jobId}

Usage and SDK Samples

curl -X GET "https://api.imdatacenter.com/1.0/email/{jobId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReverseEmailAppendApi;

import java.io.File;
import java.util.*;

public class ReverseEmailAppendApiExample {

    public static void main(String[] args) {
        
        ReverseEmailAppendApi apiInstance = new ReverseEmailAppendApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200_2 result = apiInstance.emailStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReverseEmailAppendApi#emailStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReverseEmailAppendApi;

public class ReverseEmailAppendApiExample {

    public static void main(String[] args) {
        ReverseEmailAppendApi apiInstance = new ReverseEmailAppendApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200_2 result = apiInstance.emailStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReverseEmailAppendApi#emailStatus");
            e.printStackTrace();
        }
    }
}
String *jobId = jobId_example; // The id value that was returned when the job was created.

ReverseEmailAppendApi *apiInstance = [[ReverseEmailAppendApi alloc] init];

// get results
[apiInstance emailStatusWith:jobId
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');

var api = new IntegratedMarketingDatacenterApi.ReverseEmailAppendApi()

var jobId = jobId_example; // {String} The id value that was returned when the job was created.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.emailStatus(jobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class emailStatusExample
    {
        public void main()
        {
            
            var apiInstance = new ReverseEmailAppendApi();
            var jobId = jobId_example;  // String | The id value that was returned when the job was created.

            try
            {
                // get results
                inline_response_200_2 result = apiInstance.emailStatus(jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReverseEmailAppendApi.emailStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ReverseEmailAppendApi();
$jobId = jobId_example; // String | The id value that was returned when the job was created.

try {
    $result = $api_instance->emailStatus($jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReverseEmailAppendApi->emailStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReverseEmailAppendApi;

my $api_instance = WWW::SwaggerClient::ReverseEmailAppendApi->new();
my $jobId = jobId_example; # String | The id value that was returned when the job was created.

eval { 
    my $result = $api_instance->emailStatus(jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReverseEmailAppendApi->emailStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ReverseEmailAppendApi()
jobId = jobId_example # String | The id value that was returned when the job was created.

try: 
    # get results
    api_response = api_instance.email_status(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReverseEmailAppendApi->emailStatus: %s\n" % e)

Parameters

Path parameters
Name Description
jobId*
String
The id value that was returned when the job was created.
Required

Responses

Status: 200 - successful operation

Status: 400 - Invalid job id supplied

Status: 404 - Job not found


ReversePhoneAppend

phoneStart

start job

Reverse Phone Append leverages all of our telephone databases and types including Landline, Wireless, Voice Over IP (VOIP) and/or Business Phone Numbers resulting in a high match rate typically above 65% with partial name and/or address appended. The match rate is varies based on the target market and how the data is sourced. A free match analysis on your specific dataset is available upon request. In addition to name and postal address we can also append over 65 predictive demographic and lifestyle attributes in real-time. Using the name and postal address where available we can also append an email addresses which are validated in real-time for maximum deliverability and accuracy. If you have a question about any of the processing please do not hesitate to contact us as we can customize the solution to meet your needs.


/phone

Usage and SDK Samples

curl -X POST -H "x-api-key: [[apiKey]]" "https://api.imdatacenter.com/1.0/phone"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReversePhoneAppendApi;

import java.io.File;
import java.util.*;

public class ReversePhoneAppendApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ReversePhoneAppendApi apiInstance = new ReversePhoneAppendApi();
        Body_1 body = ; // Body_1 | Phone information and job details
        try {
            inline_response_201_1 result = apiInstance.phoneStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReversePhoneAppendApi#phoneStart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReversePhoneAppendApi;

public class ReversePhoneAppendApiExample {

    public static void main(String[] args) {
        ReversePhoneAppendApi apiInstance = new ReversePhoneAppendApi();
        Body_1 body = ; // Body_1 | Phone information and job details
        try {
            inline_response_201_1 result = apiInstance.phoneStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReversePhoneAppendApi#phoneStart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

Body_1 *body = ; // Phone information and job details

ReversePhoneAppendApi *apiInstance = [[ReversePhoneAppendApi alloc] init];

// start job
[apiInstance phoneStartWith:body
              completionHandler: ^(inline_response_201_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');
var defaultClient = IntegratedMarketingDatacenterApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new IntegratedMarketingDatacenterApi.ReversePhoneAppendApi()

var body = ; // {Body_1} Phone information and job details


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.phoneStart(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class phoneStartExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new ReversePhoneAppendApi();
            var body = new Body_1(); // Body_1 | Phone information and job details

            try
            {
                // start job
                inline_response_201_1 result = apiInstance.phoneStart(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReversePhoneAppendApi.phoneStart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\ReversePhoneAppendApi();
$body = ; // Body_1 | Phone information and job details

try {
    $result = $api_instance->phoneStart($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReversePhoneAppendApi->phoneStart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReversePhoneAppendApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ReversePhoneAppendApi->new();
my $body = WWW::SwaggerClient::Object::Body_1->new(); # Body_1 | Phone information and job details

eval { 
    my $result = $api_instance->phoneStart(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReversePhoneAppendApi->phoneStart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ReversePhoneAppendApi()
body =  # Body_1 | Phone information and job details

try: 
    # start job
    api_response = api_instance.phone_start(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReversePhoneAppendApi->phoneStart: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - successful operation

Status: 400 - Invalid input


phoneStatus

get results

Retrieve the results from a previously started /phone job.


/phone/{jobId}

Usage and SDK Samples

curl -X GET "https://api.imdatacenter.com/1.0/phone/{jobId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReversePhoneAppendApi;

import java.io.File;
import java.util.*;

public class ReversePhoneAppendApiExample {

    public static void main(String[] args) {
        
        ReversePhoneAppendApi apiInstance = new ReversePhoneAppendApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200_1 result = apiInstance.phoneStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReversePhoneAppendApi#phoneStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReversePhoneAppendApi;

public class ReversePhoneAppendApiExample {

    public static void main(String[] args) {
        ReversePhoneAppendApi apiInstance = new ReversePhoneAppendApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200_1 result = apiInstance.phoneStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReversePhoneAppendApi#phoneStatus");
            e.printStackTrace();
        }
    }
}
String *jobId = jobId_example; // The id value that was returned when the job was created.

ReversePhoneAppendApi *apiInstance = [[ReversePhoneAppendApi alloc] init];

// get results
[apiInstance phoneStatusWith:jobId
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');

var api = new IntegratedMarketingDatacenterApi.ReversePhoneAppendApi()

var jobId = jobId_example; // {String} The id value that was returned when the job was created.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.phoneStatus(jobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class phoneStatusExample
    {
        public void main()
        {
            
            var apiInstance = new ReversePhoneAppendApi();
            var jobId = jobId_example;  // String | The id value that was returned when the job was created.

            try
            {
                // get results
                inline_response_200_1 result = apiInstance.phoneStatus(jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReversePhoneAppendApi.phoneStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ReversePhoneAppendApi();
$jobId = jobId_example; // String | The id value that was returned when the job was created.

try {
    $result = $api_instance->phoneStatus($jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReversePhoneAppendApi->phoneStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReversePhoneAppendApi;

my $api_instance = WWW::SwaggerClient::ReversePhoneAppendApi->new();
my $jobId = jobId_example; # String | The id value that was returned when the job was created.

eval { 
    my $result = $api_instance->phoneStatus(jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReversePhoneAppendApi->phoneStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ReversePhoneAppendApi()
jobId = jobId_example # String | The id value that was returned when the job was created.

try: 
    # get results
    api_response = api_instance.phone_status(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReversePhoneAppendApi->phoneStatus: %s\n" % e)

Parameters

Path parameters
Name Description
jobId*
String
The id value that was returned when the job was created.
Required

Responses

Status: 200 - successful operation

Status: 400 - Invalid job id supplied

Status: 404 - Job not found


reversephonePhoneStart

start job

Reverse Phone Append leverages all of our telephone databases and types including Landline, Wireless, Voice Over IP (VOIP) and/or Business Phone Numbers resulting in a high match rate typically above 65% with partial name and/or address appended. The match rate is varies based on the target market and how the data is sourced. A free match analysis on your specific dataset is available upon request. In addition to name and postal address we can also append over 65 predictive demographic and lifestyle attributes in real-time. Using the name and postal address where available we can also append an email addresses which are validated in real-time for maximum deliverability and accuracy. If you have a question about any of the processing please do not hesitate to contact us as we can customize the solution to meet your needs.


/reversephone

Usage and SDK Samples

curl -X POST -H "x-api-key: [[apiKey]]" "https://api.imdatacenter.com/1.0/reversephone"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReversePhoneAppendApi;

import java.io.File;
import java.util.*;

public class ReversePhoneAppendApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ReversePhoneAppendApi apiInstance = new ReversePhoneAppendApi();
        Body_7 body = ; // Body_7 | Phone information and job details
        try {
            inline_response_201_1 result = apiInstance.reversephonePhoneStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReversePhoneAppendApi#reversephonePhoneStart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReversePhoneAppendApi;

public class ReversePhoneAppendApiExample {

    public static void main(String[] args) {
        ReversePhoneAppendApi apiInstance = new ReversePhoneAppendApi();
        Body_7 body = ; // Body_7 | Phone information and job details
        try {
            inline_response_201_1 result = apiInstance.reversephonePhoneStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReversePhoneAppendApi#reversephonePhoneStart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

Body_7 *body = ; // Phone information and job details

ReversePhoneAppendApi *apiInstance = [[ReversePhoneAppendApi alloc] init];

// start job
[apiInstance reversephonePhoneStartWith:body
              completionHandler: ^(inline_response_201_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');
var defaultClient = IntegratedMarketingDatacenterApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new IntegratedMarketingDatacenterApi.ReversePhoneAppendApi()

var body = ; // {Body_7} Phone information and job details


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.reversephonePhoneStart(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class reversephonePhoneStartExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new ReversePhoneAppendApi();
            var body = new Body_7(); // Body_7 | Phone information and job details

            try
            {
                // start job
                inline_response_201_1 result = apiInstance.reversephonePhoneStart(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReversePhoneAppendApi.reversephonePhoneStart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\ReversePhoneAppendApi();
$body = ; // Body_7 | Phone information and job details

try {
    $result = $api_instance->reversephonePhoneStart($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReversePhoneAppendApi->reversephonePhoneStart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReversePhoneAppendApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ReversePhoneAppendApi->new();
my $body = WWW::SwaggerClient::Object::Body_7->new(); # Body_7 | Phone information and job details

eval { 
    my $result = $api_instance->reversephonePhoneStart(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReversePhoneAppendApi->reversephonePhoneStart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ReversePhoneAppendApi()
body =  # Body_7 | Phone information and job details

try: 
    # start job
    api_response = api_instance.reversephone_phone_start(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReversePhoneAppendApi->reversephonePhoneStart: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - successful operation

Status: 400 - Invalid input


reversephonePhoneStatus

get results

Retrieve the results from a previously started /phone job.


/reversephone/{jobId}

Usage and SDK Samples

curl -X GET "https://api.imdatacenter.com/1.0/reversephone/{jobId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReversePhoneAppendApi;

import java.io.File;
import java.util.*;

public class ReversePhoneAppendApiExample {

    public static void main(String[] args) {
        
        ReversePhoneAppendApi apiInstance = new ReversePhoneAppendApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200_7 result = apiInstance.reversephonePhoneStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReversePhoneAppendApi#reversephonePhoneStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReversePhoneAppendApi;

public class ReversePhoneAppendApiExample {

    public static void main(String[] args) {
        ReversePhoneAppendApi apiInstance = new ReversePhoneAppendApi();
        String jobId = jobId_example; // String | The id value that was returned when the job was created.
        try {
            inline_response_200_7 result = apiInstance.reversephonePhoneStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReversePhoneAppendApi#reversephonePhoneStatus");
            e.printStackTrace();
        }
    }
}
String *jobId = jobId_example; // The id value that was returned when the job was created.

ReversePhoneAppendApi *apiInstance = [[ReversePhoneAppendApi alloc] init];

// get results
[apiInstance reversephonePhoneStatusWith:jobId
              completionHandler: ^(inline_response_200_7 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');

var api = new IntegratedMarketingDatacenterApi.ReversePhoneAppendApi()

var jobId = jobId_example; // {String} The id value that was returned when the job was created.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.reversephonePhoneStatus(jobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class reversephonePhoneStatusExample
    {
        public void main()
        {
            
            var apiInstance = new ReversePhoneAppendApi();
            var jobId = jobId_example;  // String | The id value that was returned when the job was created.

            try
            {
                // get results
                inline_response_200_7 result = apiInstance.reversephonePhoneStatus(jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReversePhoneAppendApi.reversephonePhoneStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ReversePhoneAppendApi();
$jobId = jobId_example; // String | The id value that was returned when the job was created.

try {
    $result = $api_instance->reversephonePhoneStatus($jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReversePhoneAppendApi->reversephonePhoneStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReversePhoneAppendApi;

my $api_instance = WWW::SwaggerClient::ReversePhoneAppendApi->new();
my $jobId = jobId_example; # String | The id value that was returned when the job was created.

eval { 
    my $result = $api_instance->reversephonePhoneStatus(jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReversePhoneAppendApi->reversephonePhoneStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ReversePhoneAppendApi()
jobId = jobId_example # String | The id value that was returned when the job was created.

try: 
    # get results
    api_response = api_instance.reversephone_phone_status(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReversePhoneAppendApi->reversephonePhoneStatus: %s\n" % e)

Parameters

Path parameters
Name Description
jobId*
String
The id value that was returned when the job was created.
Required

Responses

Status: 200 - successful operation

Status: 400 - Invalid job id supplied

Status: 404 - Job not found


Verification

emailVerificationStart

start job

Email varification


/verification

Usage and SDK Samples

curl -X POST -H "x-api-key: [[apiKey]]" "https://api.imdatacenter.com/1.0/verification"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VerificationApi;

import java.io.File;
import java.util.*;

public class VerificationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        VerificationApi apiInstance = new VerificationApi();
        Body_6 body = ; // Body_6 | Email information
        try {
            inline_response_201_1 result = apiInstance.emailVerificationStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VerificationApi#emailVerificationStart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VerificationApi;

public class VerificationApiExample {

    public static void main(String[] args) {
        VerificationApi apiInstance = new VerificationApi();
        Body_6 body = ; // Body_6 | Email information
        try {
            inline_response_201_1 result = apiInstance.emailVerificationStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VerificationApi#emailVerificationStart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

Body_6 *body = ; // Email information

VerificationApi *apiInstance = [[VerificationApi alloc] init];

// start job
[apiInstance emailVerificationStartWith:body
              completionHandler: ^(inline_response_201_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegratedMarketingDatacenterApi = require('integrated_marketing_datacenter_api');
var defaultClient = IntegratedMarketingDatacenterApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new IntegratedMarketingDatacenterApi.VerificationApi()

var body = ; // {Body_6} Email information


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.emailVerificationStart(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class emailVerificationStartExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new VerificationApi();
            var body = new Body_6(); // Body_6 | Email information

            try
            {
                // start job
                inline_response_201_1 result = apiInstance.emailVerificationStart(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VerificationApi.emailVerificationStart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\VerificationApi();
$body = ; // Body_6 | Email information

try {
    $result = $api_instance->emailVerificationStart($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VerificationApi->emailVerificationStart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VerificationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VerificationApi->new();
my $body = WWW::SwaggerClient::Object::Body_6->new(); # Body_6 | Email information

eval { 
    my $result = $api_instance->emailVerificationStart(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VerificationApi->emailVerificationStart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VerificationApi()
body =  # Body_6 | Email information

try: 
    # start job
    api_response = api_instance.email_verification_start(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VerificationApi->emailVerificationStart: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Job started

Status: 400 - Invalid input