MatchingRequest

Get matches count for a given individual details.

Individual details are sent as a raw POST body. The MD5 hash result of this body is concatenated to the link as shown in the example below.


Fields

The MatchingRequest object contains the following fields:

Name Description Type Access Mode

count

The total matches found for the given individual

int

read

link

Link to the matches page in MyHeritage website

string

read

request_id

The request id which identifies the matching request

string

read

minimal_match_confidence

The minimal match confidence requested

int

read

record_matches

Number of record matches per match status

MatchesCount object: match_type, pending, confirmed, rejected, total, new, ignored_sources, ignored_individuals, aggregated_value_add and class_name fields

read

smart_matches

Number of smart matches per match status

MatchesCount object: match_type, pending, confirmed, rejected, total, new, ignored_sources, ignored_individuals, aggregated_value_add and class_name fields

read

aggregate_value_add

The aggregatevalueadd sub-element describes the aggregate added value of all pending matches for this individual. It is added only if there are any pending matches in this request

AggregateValueAdd object: smart_matches, record_matches, all and class_name fields

read

class_name

The object class name

string

read

POST Body

Individual details in JSON format

Connections

The MatchingRequest object contains the following connections:
Name Description Type Access Mode

counts

Match counts

MatchingRequest object

read

Example

POST Body

{
         "first_name": "John Fitzgerald",
         "last_name": "Kennedy",
         "is_alive": false,
         "gender": "M",
         "events": [
             {
                 "event_type": "BIRT",
                 "date": "May 29 1917",
                 "place": "Brookline, Massachusetts"
             },
             {
                 "event_type": "DEAT",
                 "date": "Nov 22 1963",
                 "place": "Dallas, Texas"
             }
         ],
         "close_family": [
             {
                 "first_name": "Joseph Patrick",
                 "last_name": "Kennedy",
                 "relationship_type": "father"
             },
             {
                 "first_name": "Rose",
                 "last_name": "Kennedy",
                 "married_surname": "Fitzgerald",
                 "relationship_type": "mother"
             },
             {
                 "first_name": "Robert Francis",
                 "last_name": "Kennedy",
                 "nickname": "Bobby",
                 "gender": "M",
                 "relationship_type": "sibling"
             },
             {
                 "first_name": "Jacqueline Lee",
                 "last_name": "Bouvier",
                 "married_surname": "Kennedy Onassis",
                 "gender": "F",
                 "relationship_type": "wife",
                 "events": [
                     {
                         "event_type": "BIRT",
                         "date": "July 28 1929"
                     },
                     {
                         "event_type": "DEAT",
                         "date": "May 19 1994"
                     }
                 ],
                 "family_events": [
                     {
                         "event_type": "MARR",
                         "date": "Sep 12 1953",
                         "place": "Newport, Rhode Island"
                     }
                 ]
             }
         ]
    }
https://familygraph.myheritage.com/matchingrequest-7e10f77f89bd1729fa2c2c72d72d4217?match_status=pending,confirmed,rejected&minimal_match_confidence=20
{
"count": 4,
"link": "https:\/\/www.myheritage.com\/FP\/record-matches.php?action=showAdHocRecordMatchesResultsList&mrid=7e10f77f89bd1729fa2c2c72d72d4217",
"request_id": "7e10f77f89bd1729fa2c2c72d72d4217",
"record_matches": {
"pending": 2,
"confirmed": 0,
"rejected": 0,
"class_name": "MatchesCount"
},
"smart_matches": {
"pending": 2,
"confirmed": 0,
"rejected": 0,
"class_name": "MatchesCount"
},
"aggregate_value_add": {
"smart_matches": {
"score": 30,
"factors": [
{
"name": "birthplace",
"modifier": "improves",
"group": "facts",
"class_name": "ValueAddFactor"
},
{
"name": "deathplace",
"modifier": "improves",
"group": "facts",
"class_name": "ValueAddFactor"
},
{
"name": "child",
"modifier": "adds",
"group": "relatives",
"class_name": "ValueAddFactor"
}
],
"factors_description": "more complete birth place, more complete death place and child(ren)",
"class_name": "ValueAddElement"
},
"record_matches": {
"score": 10,
"class_name": "ValueAddElement"
},
"all": {
"score": 15,
"factors": [
{
"name": "birthplace",
"modifier": "improves",
"group": "facts",
"class_name": "ValueAddFactor"
},
{
"name": "deathplace",
"modifier": "improves",
"group": "facts",
"class_name": "ValueAddFactor"
},
{
"name": "child",
"modifier": "adds",
"group": "relatives",
"class_name": "ValueAddFactor"
}
],
"factors_description": "more complete birth place, more complete death place and child(ren)",
"class_name": "ValueAddElement"
},
"class_name": "AggregateValueAdd"
},
"class_name": "MatchingRequest"
}