Read Genealogies Person Matches
The Person Matches by Genealogies Person Id resource defines the set of matches in the system for a person in the user-submitted genealogies.
The scope of the match results can be limited to a specific collection by using the collection query parameter.
Use of the this resource in a production environment is restricted to applications that have been certified. Hinting applications must be certified. See Record Hinting Certification.
Currently, only the following collections support match results:
| title | identifier | description |
|---|---|---|
| FamilySearch Records | https://familysearch.org/platform/collections/records (or just "records") | The set of FamilySearch records. |
If no collection is specified, the "records" collection will be assumed.
Path parameters
The ID of the genealogies person (from user-submitted genealogies) to match against. To find genealogies person IDs, see <a href="/reference/readgenealogiespersons" target="_blank">Read Genealogies Persons</a>.
Query parameters
The name of the collection in which to find matches (records or tree).
The minimum level of confidence of the results. The higher the number the higher the confidence desired.
The number of results to provide.
The match status(es) by which to filter the results. The default is all statuses are returned.
Headers
Specifies the media type(s) that the client is willing to accept in the response.
Response
The read was successful. See <a href="https://developers.familysearch.org/main/docs/json-schema#person" target="_blank">Person Schema (JSON)</a>