Person Matching

FREEMIUM
By matchbox.io
Updated 4 months ago
Data
-/10
Popularity Score
-
Latency
-
Success Rate

Person Matching API Documentation

The matchbox.io Match API identifies and deduplicates individuals by providing a consistent identifier. By correcting spelling errors and using "fuzzy" match logic, the API can be used to track an individual across different marketing channels, including mailing, email and social. The API can also be used to identify members of the same household and to append third party data. Check out http://matchbox.io to find out more.

View API Details
POSTUpdate
GETPerson
GETHousehold
POSTUpdate

Uses the provided information to update a person in matchbox.io. If enough contact information is provide, such as a name and address, an email address or a web cookie, that information is used to perform a match and update the person's contact information. If a match is not found, a new person is created within your matchbox.io account. In addition, the entire person JSON document is returned. The matching methodology may be modified if necessary. Check out matchbox.io for more details.

Authorization:

API Key Authentication

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
apikeyHEADER
REQUIREDYour matchbox.io API Key
accesskeySTRING
OPTIONALAccess keys allow you to query data from one of our data providers. Find out more at http://matchbox.io.
Optional Parameters
emailSTRING
OPTIONALThe email address of the individual, if known.
first_nameSTRING
OPTIONALThe first name of the individual, if known.
middle_nameSTRING
OPTIONALThe middle name of the individual, if known.
last_nameSTRING
OPTIONALThe last name of the individual, if known.
addr_1STRING
OPTIONALThe first address line for the individual, if known.
addr_2STRING
OPTIONALThe second address line for the individual, if known.
citySTRING
OPTIONALThe city address for the individual, if known.
stateSTRING
OPTIONALThe state for the individual, if known.
zipSTRING
OPTIONALThe zip code for the individual, if known.
twitterSTRING
OPTIONALThe twitter account for the individual, if known.
cookieSTRING
OPTIONALAny web cookies associated with the individual.
sourceSTRING
OPTIONALThe source of the individual record. All sources will be tracked in the "sources" array.
full_nameSTRING
OPTIONALThe full name of the individual, if known. This will be parsed into individual name elements. Parsed name information in the first_name, middle_name and last_name parameters will trump the full_name parameter when both are provided.
city_state_zipSTRING
OPTIONALThe city, state and zip of the address, when known. Useful for when this information is not parsed.
customer_idSTRING
OPTIONALA unique customer identifier if used. Must be at least 10 characters and should be unique to the person.
Code Snippet
unirest.post("https://matchbox.p.rapidapi.com/update")
.header("X-RapidAPI-Host", "matchbox.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.send("[email protected]")
.send("first_name=Barack")
.send("middle_name=Hussein")
.send("last_name=Obama")
.send("addr_1=1600 Pennsylvania Ave")
.send("city=Washington")
.send("state=DC")
.send("zip=20500")
.send("[email protected]")
.send("source=mashape.com")
.send("full_name=Barack Obama")
.send("city_state_zip=Washington DC 20500")
.send("customer_id=01234567890")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response
General
Request URL: https://matchbox.p.rapidapi.com/update
Request Method: POST
Response Headers
Response Body

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.post("https://matchbox.p.rapidapi.com/update")
.header("X-RapidAPI-Host", "matchbox.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.send("[email protected]")
.send("first_name=Barack")
.send("middle_name=Hussein")
.send("last_name=Obama")
.send("addr_1=1600 Pennsylvania Ave")
.send("city=Washington")
.send("state=DC")
.send("zip=20500")
.send("[email protected]")
.send("source=mashape.com")
.send("full_name=Barack Obama")
.send("city_state_zip=Washington DC 20500")
.send("customer_id=01234567890")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication