Identifiers

The fields you can submit for matching are:

first_name
last_name
street
city
state
postal_code
phones
email

Rules

Depending on the data provided, different matching strategies, or rules, are applied. By default, a rule that best matches a set of identifiers is automatically selected. Optionally declare the rules from the following list:

Rule

Description

Default

name_address

Match by name and address.

yes

email

Match by email.

yes

phone

Match by phone.

no

address

Match by street and region (city, state, or postal_code).

no

Filters

The filter parameter reduces the potential results to only those records exactly matching a specified criteria.
See the Search API for more information.

Fields

By default, all fields in the Data Dictionary are included in the output. Use the fields parameter to reduce the number of elements returned:

Bulk Requests

Batch

Large volumes of match requests can be processed as a batch. A batch is a group of records that can be appended to. If you submit a bulk request with a batch_id, we will assign that ID to the batch. If one is not supplied, that group of match requests will be assigned a new random batch ID. Be sure to save the batch_id as it is required to fetch the match results.

Request

POST /api/1/people/match/bulk

With one bulk request API call, multiple match requests can be performed in a new batch or be appended to an existing batch by providing a batch_id.

Return multiple results up to the given limit count. Max 400 of results.

1

Getting Bulk Match Results

GET /api/1/people/match/results?batch_id=:batch_id

All bulk match request API responses include a batch_id. Calling the results endpoint with the batch_id fetches the first set of available results for that batch. Matches that are pending will not appear in the results.