Person Matches by Example
The Person Matches by Example resource returns a list of possible FamilySearch tree persons that match a person described by either query parameters (GET) or a GEDCOM X document containing person details (POST). This resource is particularly useful for matching a person in an external tree to a person in the FamilySearch tree. The Match by Tree Person Id resource should be used to find matches (possible duplicates) for a specific person already in the FamilySearch tree.
Each entry in the match results may contain content of the GEDCOM X media type that provides data about the results, e.g., persons and relationships.
Person Matches are non-exact. The match algorithm will take into account all of the information given about the
person (and the person's parents, children and spouses, if included) and return matches, each having a likelihood
of the match being the same person that was specified in the request. Because the match algorithm is non-exact, a
returned match may have information that does not exactly match the information specified in the request. The
likelihood is contained in the
ResultConfidence field of each
Entry (match result).
Dates can be specific (20 July 1946), partial (May 1836 or just 1836), approximate (about 1793) or a range (1898-1903).
The following is for using the GET version of this resource:
As of May 1, 2018 this resource is deprecated because the functionality available in the POST version of this call allows more flexibility and more accurate matching.
The query parameter that describes the match criteria. A parameter name and value is separated by a colon ':' and each name-value pair is separated by a white space ' '.
Notice the white space in the birthDate value. If white space is required in the value, then the value must be wrapped in double quotes.
The following is for using the POST version of this resource:
The POST body must contain a valid GEDCOM X JSON or XML block. The following elements of the GEDCOM X are required:
|Primary Person||There must be a primary person and the primary person must have an id (such as "primaryPerson")|
|Main Source Description||There must be a main source description in the GEDCOM X document that points to the primary person (see Main sourceDescription.about below)|
|Main sourceDescription.about||The main source description's about attribute must point to the primary person via an anchor tag (i.e. about="#primaryPerson")|
Note: For more accurate results, the GEDCOM X POST body may (and should whenever possible) contain the main person's parents, spouses, and children. All of the persons in the GEDCOM X must have ID's so that relationships can be defined between the persons. Persons not specified in a relationship (other than the primary person) will be ignored when matching. The person ID's can be of any format. ID's such as "primaryPerson", "mother1","child1" etc. are acceptable and more intuitive for human understanding.
If you make a
GET request, specify the desired data format using the
POST something, specify the data format using the
Note: if you are expecting a
BODY returned from a
POST, you should also specify the format using the
|Authorization||header||The authorization carrying the OAuth 2.0 access token. See OAuth 2.0 Bearer Tokens.|
|access_token||query||The ID of the OAuth 2 access token used for identification and authorization of the user (and agent) making the request.|
|confidence||query||The level of confidence of the results, an integer from 1 to 5. The higher the number the higher the confidence desired. The default
|count||query||The number of results to provide, an integer from 1 to 100. The default value is
|q||query||The match by example query for the GET version of this resource.|
GET - Read the results of a match by example (A query is a form of an example).
As of May 1, 2018 this resource is deprecated because the functionality available in the POST version of this call will allow more flexibility and more accurate matching.
POST - Use the provided Gedcomx document to perform a match.