User GuidesAPI ReferenceRelease Notes
Doc HomeHelp CenterLog In
API Reference

Bulk Match Records or Clusters

Initiate an asynchronous match query

The body of the call, indicated with the flag --data-binary, contains the submitted records. These should be newline delimited JSON objects, and take the following form:
{"recordId": "<ID Number>", "record" : {<list of attributes>}}

For example, the following record could be submitted, where each of the keys listed under record correspond to an attribute in the unified dataset.

{"recordId":"1","record":{"NAME":["BLUE BEACH CO","BLUE BEACH SERVICES"],"CITY":["SAN DIEGO"],"ZIP":["92130"],"PHONE":["8585556765"],"URL":[],"COUNTRY_CODE":["US"],"STATE_CODE":["CA"],"ADDRESS":["6892 DEL MAR HEIGHTS RD"]}}

📘

In the above example, each of the attributes is expressed as a list. This is only necessary if those fields in the dataset you are matching to are represented as multi-value arrays. If the unified attributes are not multi-valued, then the attributes can just be a key-value pair. For example, "ZIP": "92130"

Response Fields

This endpoint returns an operation object describing the operation that has been submitted. In order to see the results of the bulk match, you must submit the operation ID to the Bulk Match Results endpoint. This operation ID is in the response-body as id.

Language