Match

API change history

Match is a very powerful tool for people and companies that can take partial info using proprietary algorithms to come up with a list of matches that could be what you are looking for. Along with each result you get a score indicating how close we think the match is. This is perfect for when you may or may not have a full name or address, but still need to make that delivery. Regular search just won't cut it in this case since the search criteria may or may not be complete. What's the difference between Match and Search? Search is a set operation to meet the given criteria (similar to a SQL query). Match provides the ability to find that one golden person or company record that fits closest to the given criteria.

Multiple Match

Execute several match requests in a single submission

Try it

Request URL

Request parameters

(optional)
string

A 32-character authentication key issued during registration. This is a required parameter.

Request headers

string

The accept header is used to tell the API what format you would like any data returned in. Just like the Content-Type parameter, you can specify 'application/json' for JSON and 'application/xml' for XML. This parameter controls all the data that the Infoconnect API returns, which includes error messages as well. If you don't include the Accept header, or specify something other than JSON or XML, the API returns a HTTP status of 415. This is the API telling you it doesn't support the format you asked for. 

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.

Request body

[
  {
    "City": "Papillion",
    "CompanyName": "Infogroup",
    "Limit": 1,
    "RequestId": "1",
    "RequestType": "Company",
    "StateProvince": "NE"
  },
  {
    "City": "Omaha",
    "CompanyName": "Subway",
    "Limit": 1,
    "RequestId": "2",
    "RequestType": "Company",
    "StateProvince": "NE"
  }
]
{
  "example": "[\n  {\n    \"City\": \"Papillion\",\n    \"CompanyName\": \"Infogroup\",\n    \"Limit\": 1,\n    \"RequestId\": \"1\",\n    \"RequestType\": \"Company\",\n    \"StateProvince\": \"NE\"\n  },\n  {\n    \"City\": \"Omaha\",\n    \"CompanyName\": \"Subway\",\n    \"Limit\": 1,\n    \"RequestId\": \"2\",\n    \"RequestType\": \"Company\",\n    \"StateProvince\": \"NE\"\n  }\n]"
}
[
  {
    "City": "Papillion",
    "CompanyName": "Infogroup",
    "Limit": 1,
    "RequestId": "1",
    "RequestType": "Company",
    "StateProvince": "NE"
  },
  {
    "City": "Omaha",
    "CompanyName": "Subway",
    "Limit": 1,
    "RequestId": "2",
    "RequestType": "Company",
    "StateProvince": "NE"
  }
]
{
  "example": "[\n  {\n    \"City\": \"Papillion\",\n    \"CompanyName\": \"Infogroup\",\n    \"Limit\": 1,\n    \"RequestId\": \"1\",\n    \"RequestType\": \"Company\",\n    \"StateProvince\": \"NE\"\n  },\n  {\n    \"City\": \"Omaha\",\n    \"CompanyName\": \"Subway\",\n    \"Limit\": 1,\n    \"RequestId\": \"2\",\n    \"RequestType\": \"Company\",\n    \"StateProvince\": \"NE\"\n  }\n]"
}

Response 200

The operation returned responses matching the submitted criteria.

[{
  "MatchCount": 1,
  "Matches": {
    "Common": [{
      "ETag": "99ba21e",
      "Id": "826381212",
      "Links": [{
        "Href": "\/v1\/companies\/826381212",
        "Rel": "self"
      }, {
        "Href": "\/v1\/companies\/623576402",
        "Rel": "parent"
      }],
      "Address": "1020 E 1st St",
      "AddressParsed": {
        "Name": "1st",
        "Number": "1020",
        "PreDirectional": "E",
        "Suffix": "St"
      },
      "City": "Papillion",
      "CompanyName": "Infogroup Inc",
      "FirstName": "Mike",
      "LastName": "Iaccarino",
      "Location": {
        "Latitude": 41.157848,
        "Longitude": -96.029902
      },
      "Phone": "4028364500",
      "PostalCode": "68046",
      "RuleName": "Company-CompanyName",
      "Score": 80,
      "StateProvince": "NE"
    }],
    "Companies": [],
    "People": []
  },
  "RequestId": "1",
  "ScoreSummary": [{
    "Href": "\/v1\/companies\/826381212",
    "ResourceType": "Company",
    "RuleName": "Company-CompanyName",
    "Score": 80
  }]
}, {
  "MatchCount": 1,
  "Matches": {
    "Common": [{
      "ETag": "8d4431d7",
      "Id": "598561702",
      "Links": [{
        "Href": "\/v1\/companies\/598561702",
        "Rel": "self"
      }, {
        "Href": "\/v1\/companies\/452186299",
        "Rel": "parent"
      }],
      "Address": "10000 California St # Fc11",
      "AddressParsed": {
        "Name": "California",
        "Number": "10000",
        "Suffix": "St",
        "UnitNumber": "FC11"
      },
      "City": "Omaha",
      "CompanyName": "SUBWAY",
      "FirstName": "Pam",
      "LastName": "Henggeler",
      "Location": {
        "Latitude": 41.266735,
        "Longitude": -96.068540
      },
      "Phone": "4023971257",
      "PostalCode": "68114",
      "RuleName": "Company-CompanyName",
      "Score": 80,
      "StateProvince": "NE"
    }],
    "Companies": [],
    "People": []
  },
  "RequestId": "2",
  "ScoreSummary": [{
    "Href": "\/v1\/companies\/598561702",
    "ResourceType": "Company",
    "RuleName": "Company-CompanyName",
    "Score": 80
  }]
}]
<ArrayOfMatchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schema.infoconnect.com">
<MatchResponse>
    <MatchCount>1</MatchCount>
    <Matches>
        <Common>
            <Basic>
                <ETag>99ba21e</ETag>
                <Id>826381212</Id>
                <Links>
                    <Link>
                        <Href>/v1/companies/826381212</Href>
                        <Rel>self</Rel>
                    </Link>
                    <Link>
                        <Href>/v1/companies/623576402</Href>
                        <Rel>parent</Rel>
                    </Link>
                </Links>
                <Address>1020 E 1st St</Address>
                <AddressParsed>
                    <Name>1st</Name>
                    <Number>1020</Number>
                    <PreDirectional>E</PreDirectional>
                    <Suffix>St</Suffix>
                </AddressParsed>
                <City>Papillion</City>
                <CompanyName>Infogroup Inc</CompanyName>
                <FirstName>Mike</FirstName>
                <LastName>Iaccarino</LastName>
                <Location>
                    <Latitude>41.157848</Latitude>
                    <Longitude>-96.029902</Longitude>
                </Location>
                <Phone>4028364500</Phone>
                <PostalCode>68046</PostalCode>
                <RuleName>Company-CompanyName</RuleName>
                <Score>80</Score>
                <StateProvince>NE</StateProvince>
            </Basic>
        </Common>
        <Companies/>
        <People/>
    </Matches>
    <RequestId>1</RequestId>
    <ScoreSummary>
        <MatchScore>
            <Href>/v1/companies/826381212</Href>
            <ResourceType>Company</ResourceType>
            <RuleName>Company-CompanyName</RuleName>
            <Score>80</Score>
        </MatchScore>
    </ScoreSummary>
</MatchResponse>
<MatchResponse>
    <MatchCount>1</MatchCount>
    <Matches>
        <Common>
            <Basic>
                <ETag>8d4431d7</ETag>
                <Id>598561702</Id>
                <Links>
                    <Link>
                        <Href>/v1/companies/598561702</Href>
                        <Rel>self</Rel>
                    </Link>
                    <Link>
                        <Href>/v1/companies/452186299</Href>
                        <Rel>parent</Rel>
                    </Link>
                </Links>
                <Address>10000 California St # Fc11</Address>
                <AddressParsed>
                    <Name>California</Name>
                    <Number>10000</Number>
                    <Suffix>St</Suffix>
                    <UnitNumber>FC11</UnitNumber>
                </AddressParsed>
                <City>Omaha</City>
                <CompanyName>SUBWAY</CompanyName>
                <FirstName>Pam</FirstName>
                <LastName>Henggeler</LastName>
                <Location>
                    <Latitude>41.266735</Latitude>
                    <Longitude>-96.068540</Longitude>
                </Location>
                <Phone>4023971257</Phone>
                <PostalCode>68114</PostalCode>
                <RuleName>Company-CompanyName</RuleName>
                <Score>80</Score>
                <StateProvince>NE</StateProvince>
            </Basic>
        </Common>
        <Companies/>
        <People/>
    </Matches>
    <RequestId>2</RequestId>
    <ScoreSummary>
        <MatchScore>
            <Href>/v1/companies/598561702</Href>
            <ResourceType>Company</ResourceType>
            <RuleName>Company-CompanyName</RuleName>
            <Score>80</Score>
        </MatchScore>
    </ScoreSummary>
</MatchResponse>
</ArrayOfMatchResponse>

Response 400

The server cannot process the request due to a perceived client error (e.g., invalid request value, malformed request syntax).

Response 401

The request cannot be completed because it lacks valid authentication credentials. Confirm that a valid subscription key (apikey) is included in either the query or header.

{
  "statusCode": 401,
  "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API."
}
<Error xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schema.infoconnect.com">
  <StatusCode>401</StatusCode>
  <Message>Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API.</Message>
</Error>

Response 403

Quota exceeded

{
  "statusCode": 403,
  "message": "Out of call volume quota."
}
<Error xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schema.infoconnect.com">
  <StatusCode>403</StatusCode>
  <Message>Out of call volume quota.</Message>
</Error>

Response 404

Client was able to communicate with the server, but the id requested was not found.

{
  "statusCode": 404,
  "message": "Client was able to communicate with the server, but the id requested was not found."
}
<Error xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schema.infoconnect.com">
  <StatusCode>404</StatusCode>
  <Message>Client was able to communicate with the server, but the id requested was not found.</Message>
</Error>

Response 429

Rate limit exceeded.

{
  "statusCode": 429,
  "message": "Rate limit is exceeded. Try again in 55 seconds."
}
<Error xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schema.infoconnect.com">
  <StatusCode>429</StatusCode>
  <Message>Rate limit is exceeded. Try again in 55 seconds.</Message>
</Error>

Response 500

The Web server (running the Web Site) encountered an unexpected condition that prevented it from fulfilling the request by the client.

{
  "statusCode": 500,
  "message": "The Web server (running the Web Site) encountered an unexpected condition that prevented it from fulfilling the request by the client."
}
<Error xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schema.infoconnect.com">
  <StatusCode>500</StatusCode>
  <Message>The Web server (running the Web Site) encountered an unexpected condition that prevented it from fulfilling the request by the client.</Message>
</Error>

Code samples

@ECHO OFF

curl -v -X POST "https://api.infoconnect.com/v3/multiplematch?apikey={string}"
-H "Accept: application/json"
-H "Content-Type: application/json"
-H "apikey: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

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

            // Request headers

            client.DefaultRequestHeaders.Accept.Add(MediaTypeWithQualityHeaderValue.Parse("application/json"));
            client.DefaultRequestHeaders.Add("apikey", "{subscription key}");

            // Request parameters
            queryString["apikey"] = "{string}";
            var uri = "https://api.infoconnect.com/v3/multiplematch?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

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

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

        try
        {
            URIBuilder builder = new URIBuilder("https://api.infoconnect.com/v3/multiplematch");

            builder.setParameter("apikey", "{string}");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Accept", "application/json");
            request.setHeader("Content-Type", "application/json");
            request.setHeader("apikey", "{subscription key}");


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

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

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

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

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "apikey": "{string}",
        };
      
        $.ajax({
            url: "https://api.infoconnect.com/v3/multiplematch?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Accept","application/json");
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("apikey","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

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

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Accept"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"apikey"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

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

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

$request = new Http_Request2('https://api.infoconnect.com/v3/multiplematch');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
    'apikey' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'apikey' => '{string}',
);

$url->setQueryVariables($parameters);

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

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

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

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

headers = {
    # Request headers
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'apikey': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'apikey': '{string}',
})

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

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

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

headers = {
    # Request headers
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'apikey': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'apikey': '{string}',
})

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

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

uri = URI('https://api.infoconnect.com/v3/multiplematch')

query = URI.encode_www_form({
    # Request parameters
    'apikey' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Accept'] = 'application/json'
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['apikey'] = '{subscription key}'
# Request body
request.body = "{body}"

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

puts response.body