User GuidesAPI ReferenceRelease Notes
Doc HomeHelp CenterLog In

Initiate an asynchronous match query.

Returns an operation, which when complete, has the results ID

You submit external records for comparison to a specified mastering project by specifying curl --data-binary @<file> or supplying newline-delimited JSON objects in the following format:

{"recordId": "<ID Number>", "record" : {<list of key:value or key:[array]>}}

For example, you can submit the following request. Each of the keys in the record object 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"]}}

Note: In this example, each record value is expressed as an array surrounded by [ ]. This format is necessary if the fields in the dataset you are matching to are multi-value arrays. If the unified attributes are not array type, then the attributes can be entered as key:value pairs. For example, "ZIP": "92130".

On success, calls to this endpoint return an operation object describing the submitted job.

To see the results of the bulk match on completion, submit the operation ID to the Fetch match query record results for a Match Results ID. endpoint. The operation ID is listed in the response body as id.

Click Try It! to start a request and see the response here!