The Match Lookup feature provides a REST API that can be integrated into the system to allow users to perform interactive searches to determine if a given entity already exists in the data. Data can then be updated using Create, Update, and Delete (CRUD) methods. Objects are passed to and from the REST API in JSON format.
Match Lookup must be enabled on a Match job to run a query against the data. Refer to Match Lookup in the Match Job Settings article for more information on enabling this feature.
To initiate a Match lookup, click the Initiate Match lookup button on the Match Lookup card of the Match job Overview page. This prepares the tables and indices required to support the lookup queries. The status on this card updates as the lookup runs.
Using an http request tool (such as Postman), set up authorization using your Syniti Knowledge Platform credentials.
When setting up the URL, enter the public API URL using the associated Match job ID. For example: https://api.syniti.com/v3/match-jobs/mjo_qr96vlikjrd2fbzDf0865PHY=/data/lookup, where the highlighted portion is the Match job ID.
Once setup is complete, build and run your query.
Query Example:
{
“columns”: [
{
“name”: “FullName”,
“value”: “JOSE ACEVEDO”
},
{
“name”: “Zip”,
“value”: “15620”
}
]
}Column name values for the query can be obtained from the Match job settings in the Field Type column for the data.
Note
If a ‘/’ exists in the Field Type column name, select only one value. For example, if the Field Type is Zip/Postcode, choose either Zip or Postcode for the query.
Troubleshooting
If your query is unsuccessful, check the following:
Ensure the Match lookup has successfully run. This can be determined from the Status on the Match Lookup card of the Match job Overview page. If the status is not successful, check your Match job settings and initiate the Match lookup again.
Ensure the column name values in your query match the Field Types names on the Match job settings.
Ensure the minimum score set for the lookup on the Match job settings is correct. A high minimum lookup score will return fewer results, so Syniti recommends setting a lower minimum lookup score.