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 {
Object 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 {
Object 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: ^(Object 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
Object 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
| Name | Description |
|---|---|
| body * |