Person Matches by Example

Description

The Person Matches by Example resource returns a list of possible FamilySearch tree persons that match a person described by 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 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 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 the persons in the GEDCOM X must have IDs 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 IDs can be of any format. IDs such as "primaryPerson", "mother1", "child1" etc. are acceptable and more intuitive for human understanding.

Operations

POST - Use the provided GedcomX document to perform a match.

Produces - Specify a returned data format using the Accept header.
Consumes - Specify the incoming data format using the Content-Type header.
Parameters
Name Type Description
collection query The name of the collection in which to find matches. The possible values are tree or cet. The default is tree. Default=tree.
confidence query The level of confidence of the results. The higher the number the higher the confidence. Min=1. Max=5.
count query The number of results to provide. Default=5. Min=1. Max=100.
treeId query The tree id of the tree in CET to match against. For use with the CET collection only. To match against the entire CET collection do not pass in.
body request-body The container for the match criteria.
Status Codes
  • 200  -  Upon a successful read.
  • 204  -  Upon a successful query with no results.
  • 400  -  If the query to be processed was unable to be understood by the application.
  • 414  -  If the application declines to process the query because it would have resulted in too many results.
  • 429  -  If the request was throttled.
Warnings
400 If the query to be processed was unable to be understood by the application.
414 If the application declines to process the query because it would have resulted in too many results.

Example Requests

Read Person Matches using Gedcomx How to request matches for a person using a Gedcomx document.
Read Person Matches using query How to request matches for a person using query parameters.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.