Certification Required
The Match by Tree Person Id endpoint defines the set of matches in the system for a person in the Family Tree.
The scope of the match results can be limited to a specific collection using the collection query parameter.
Use of the collection query parameter in a production environment is restricted to applications that have been certified. Applications requesting record matches must be certified. See Record Hinting Certification.
Currently, only the following collections support match results:
| title | identifier | description |
|---|---|---|
| FamilySearch Tree | https://familysearch.org/platform/collections/tree (or just "tree") | The set of matches (possible duplicates) in the FamilySearch tree. |
| FamilySearch Records | https://familysearch.org/platform/collections/records (or just "records") | The set of matches in the FamilySearch records. |
| FamilySearch CETs | https://familysearch.org/platform/collections/cet (or just "cet") | The set of matches in the FamilySearch Cet. |
If no collection is specified, the request will be interpreted as matches in the FamilySearch tree (possible duplicates) Family Tree.
Each match has a "status" that indicates it to be in one of the following states:
| name | identifier | description |
|---|---|---|
| Pending | http://familysearch.org/v1/Pending | The match has neither been accepted nor rejected. |
| Accepted | http://familysearch.org/v1/Accepted | The match has been accepted as valid. |
| Rejected | http://familysearch.org/v1/Rejected | The match has been rejected as invalid. |
Match results can be filtered using the status query parameter.