Match methods match data sets and return the relevant matching results.
The API Specification, also available on each method below - it requires valid username and password.
| match | Matches the supplied data sets and returns the relevant matching results. |
The match method takes the first Customer Record (CR) data set against one or many Reference Record (RR) data set as the input. One data set can be any of these combinations: one address (single-line or components) and/or one email address and/or one phone. It returns a list of matched data set pair with its matching results, such as match class, confidence level, and match category. The maximum number of CR data set is 1, the maximum number of RR data sets is 100, and id must be present.
POST https://hosted.mastersoftgroup.com/harmony/rest/{locale}/match
The request body is an MatchRestRequest object:
{
"payload": {
"from": [
{
"addresses": [ { "fullAddress": "220 george street, sydney nsw 2000" } ],
"id": "c1",
"phones": [ { "fullPhone": "12345678" } ]
}
],
"to": [
{
"addresses": [ { "fullAddress": "220 george street, sydney nsw 2000" } ],
"id": "r1",
"phones": [ { "fullPhone": "12345678" } ]
},
{
"addresses": [ { "fullAddress": "level 2, 220 george street, sydney nsw 2000" } ],
"id": "r2"
}
]
}
}
With address components:
{
"payload": {
"from": [
{
"addresses": [ { "fullAddress": "level 2, 220 george street, sydney nsw 2000" } ],
"id": "c1",
"phones": [ { "fullPhone": "12345678" } ]
}
],
"to": [
{
"addresses": [ {
"floorLevelNumber": "2",
"floorLevelType": "level",
"streetName": "george",
"streetNumber": "220",
"streetType": "street",
"locality":"sydney",
"state":"nsw"
} ],
"id": "r2"
}
]
}
}
The response body is an MatchResultRestResponse object:
{
"status": "SUCCESS",
"messages": [],
"payload": [
{
"fromId": "c1",
"toId": "r1",
"entityResults": [ {
"addressPairIdx": [ 0, 0 ],
"emailAddressPairIdx": [],
"phonePairIdx": [ 0, 0 ],
"assignedMatchClass": "H1",
"confidenceLevel": "10",
"description": "Household Match Class H1",
"matchCategory": "MATCH_CLASS"
} ]
},
{
"fromId": "c1",
"toId": "r2",
"entityResults": [ {
"addressPairIdx": [ 0, 0 ],
"emailAddressPairIdx": [],
"phonePairIdx": [],
"assignedMatchClass": "G2",
"confidenceLevel": "8",
"description": "Address Match Class G2",
"matchCategory": "MATCH_CLASS"
} ]
}
]
}