Read Compatible Checklist

Read compatible applies to applications that access FamilySearch resources in order to analyze, visualize, share, and publish the information. This includes reading information about persons, relationships, memories, photos, stories, documents, sources, discussions, and change history.

The following checkbox items will be reviewed for your solution to obtain Read Compatibile status.

[   ] Authentication Compatible

[   ] Demonstrate proper implementation of one or more of the following types of read operations.

Important! Each type of read operation listed below must be reviewed independently. Read compatibility for one type of read operation does not qualify your app for any other type of read operation.

• Read Changes
• Read Discussions
• Read Genealogies (prototype)
• Read Hints
• Read Memories (by person, by user, personas, comments)
• Read Person (details, pedigree, portraits, or search)
• Read Places
• Read Sources (by user, or by person)
• Read User

[   ] Demonstrate proper handling of cache. If the data you read is cached, do not store it in local memory, purge the cache if the back button is used and at the end of your user session.

[   ] Abide by the Data Security Practices specified in the Data Management section of the Compatibility Overview.

Read Implementation Guide

• Go to Guide

Record Hinting Compatible Checklist

Record Hinting helps users find sources and evidence that can be added to FamilySearch Family Tree to substantiate conclusions. Record Hinting applications can read persons, request hints, and redirect users to FamilySearch in order to examine possible matches and attach records that support conclusions.

The user must be directed to FamilySearch to analyze and attach possible matches because third-party applications do not have adequate access privileges to the FamilySearch historical records collection. This is primarily due to legal issues on what data third-party applications are allowed to show versus what FamilySearch is allowed to show. Therefore, FamilySearch.org provides pages that present the detailed information of the hinted possible matches to the user.

The following checkbox items will be reviewwed for your solution to obtain Record Hinting Compatible status.

[   ] Authentication Compatible

[   ] Read Compatible

[   ] Use the Person Match FamilySearch API resource to retrieve from FamilySearch or another collection a summary of hints of possible record matches for a Person ID. The application can show the summary and ratings of the possible matches but no additional information is provided by this API resource.

[   ] Provide a User Interface flow substantially similar to that shown in the Record Hinting document.

• The redirect to FamilySearch can open in the existing browser window, a new browser window, or a new browser tab.
• It is preferred that the solution redirects to the Possible Matches page. However, the solution can redirect to the Attach Historical Records to Family Tree page for analysis of a specific hinted record.

Tips

• If the solution remembers redirect requests to FamilySearch, when program flow is returned to the solution the solution might choose to check for and update changes to sources that have occurred at FamilySearch.

See Also

• Read Person Details and Relationships

Read Genealogies Compatible Checklist

The data submitted to FamilySearch Genealogies is separate from the data in FamilySearch Family Tree. With the exception of living persons, genealogies data will be publicly visible and searchable

The following checkbox items will be reviewed for your solution to obtain Genealogies Read Compatible status.

[   ] Authentication Compatible

[   ] Read Genealogies Tree

Options

• Find Person Matches
• Read Person Page
• Read Source Description
• Read a Person
• Read the Tree Contributor
• Read a Note