Becoming a Partner
FamilySearch Software Partner Application
Please send an email to:
Subject: Web Service Partner Application
Attachment: electronic agreement if not faxing
Copy, paste, and fill in the following details in the body of the email:
Potential Benefit to FamilySearch:
Potential Benefit from FamilySearch:
FSDN Google Group Account (if previously obtained):
Sanbox User Account (if previously obtained):
We will respond to your request within 5 business days.
Benefits of Partnering
Association with FamilySearch
FamilySearch International is the largest genealogy organization in the world. Millions of people use FamilySearch records, resources, and services to learn more about their family history. To help in this great pursuit, FamilySearch has been actively gathering, preserving, and sharing genealogical records worldwide for over 100 years. FamilySearch is a nonprofit organization sponsored by The Church of Jesus Christ of Latter-day Saints. Patrons may access FamilySearch services and resources free online at FamilySearch.org or through over 4,600 family history centers in 132 countries, including the main Family History Library in Salt Lake City, Utah.
FamilySearch is developing a technical platform to facilitate the development of more innovative and collaborative software products that leverage genealogical data and technical services. The purpose of the platform is to increases the number of contributors and relevant online conclusions, historical records, and media available to identify ancestors and gather artifacts that assist in telling their stories. This platform includes many large searchable databases, recommended standards and best practices, Application Programming Interfaces (APIs), helpful support, training, websites, and sample code.
FamilySearch is developing a new API based upon the evolving Gedcom X specification which includes models for Conclusions, Source Metadata, Contributor Metadata, large field-based Record Extraction Model, and definition for RESTful Web Services. This platform has endpoints based on the Gedcom X specification and other important endpoints that will facilitate cooperation across multiple vendors products by using common interfaces for discussions, watch and notify, sharing sources, and other future collalboration tools.
Vendors of certified features will be licensed to use the "FamilySearch Certified" Logo on the product packaging, website, and marketing literature. Additionally, vendors can use the "FamilySearch Certified" Logo as a click-thru graphic for a designated page on the FamilySearch website where products will be listed with certified features. FamilySearch will promote Partners that are certified through its website, conferences, and other marketing communications. A "FamilySearch Certified Software Vendor" is an organization with at least one certified application or utility.
Web Site Marketing
FamilySearch will list valuable products for the industry on their products page, giving special recognitions for certified Tree Access, Tree Connect, and Tree Share products. All products are easily browse by platform and selectable for detail descriptions, sample screens, and links directly to the vendors website. Mentions of these products show up in the support knowledge-base, FamilySearch wiki, and the developers website.
Family History Centers
Vendors of certified Tree Share and other popular products, by invitation, can agree to provide free products to the machines in the Family History Centers through a special worldwide distribution. This is one of the best ways to get exposure for Tree Share products.
FamilySearch has regular announcements, newsletters, and blog postings about new and updater products for FamilySearch employees, directors of Family History Centers, Family History Consultants, and users of FamilySearch.org that have opted in for email communications.
RootsTech is the largest genealogy conference in the United States. Over 4000 attendees came in 2012. FamilySearch is preparing to invite families and youth to increase the attendance in 2013. When Familysearch adds streaming capabilities to hundreds of Latter-day Saint meeting houses and Family History Centers throughout the country, over 40,000 viewers are expected. RootsTech is the best place to showcase certified products as an exhibitor or through classes, presentations, and unconferencing sessions. Handouts and speakers are often available from FamilySearch at all regional conferences to promote third-party products throughout the year.
Vendors of certified products can display the "FamilySearch Certified" logo on their product, website, and marketing material. FamilySearch promotes the value of certification through this logo, also encouraging the public to consider certified products first as they have been tested for quality and compliance with FamilySearch certification requirements. These logos, when placed on websites, will link directly to the FamilySearch products page so that the customer can verify the certification status.
Simple Utility or Complex Application
Depending upon the feature, qualifications for a certfied status may be as simple as reviewing a screen shot of the product menu, or as complex as generating results from provided test data for submission in accordance with a technical review. The purpose, requirements, and method for determining compliance will be clearly established. All vendors will have a business review, product UI review, a technical review, and a security review. Sometimes the business, product, and technical review can be done in one meeting. The security review is always a separate activity scheduled and perfromed by the security team.
Acceptance is confirmed for the "Trademark and Logo Guidelines" and "API License Agreements". The following agreements are reviewed for proper completion and signatures:
- Certification Application
- Application Key Request Form
- Web Services Certification Agreement
- Application Key Usage Agreement
Business and Marketing Review
The vendor of the candidate product must be an on-going entity with a business purpose and product plan including a roadmap and projected number of new users. The vendor must have a website whether or not it is offering a web application. The website will have a landing page specifically for traffic coming from FamilySearch that includes: -Video tutorial on how to get started using the features that interface with FamilySearch -Information and links for help, support, contact, and/or feedback -Full summary of product features
Marketing materials must be provided for FamilySearch's product page including:
- Artwork for company and product logos
- 3 product screen shots (750x500) jpgs and matching gif thumbnails (150x100)
A product review board examines the general usability of the product for it's intended audience. Required features for a given application or utility will be checked to see if these are in compliance. This usually is done by a demo followed by a Q&A.
Technical reviews are used to determine what programmtic calls are being made to get the various responses presented through the user interface. Various use cases are often tested to make sure the logic is in place to accomodate all the possiblities. Sometimes the product review and the technical are done in the same meeting. Tree Share applications usually take multiple meetings to see everything and go through all of the use cases that can be encountered when interfacing with a large collaborative family tree.
A security check of web, desktop, and mobile applications is done by FamilySearch software security personnel. These are done by request and the vendor does not attend or participate in any way after providing the URL for the candidate web application, installable software for the desktop application, or lend a mobile device with the software already installed. The items that are reviewed are covered in the authentication requirements for web, desktop, and mobile.covered in the authentication requirements for web, desktop, and mobile.
Development and Certification Process
In order for your application to access the API Production System, you will need to certify your product. This process includes becoming a certified software partner, which gives you additiona support and benefits.
How Do I Get Started on Development?
1. Browse the FamilySearch Developers Website
Please browse the documentation to get familiar with the features and benefits of the API
2. Request an Application Key for the API Sandbox
The API Sandbox is a limited-data sandbox environment that allows you to learn and test the various functions of the FamilySearch API. The Sandbox also gives you access to new features that will be coming in new releases of the FamilySearch API. Click here to request a Sandbox account and application key. Completion and submission of this form will generate a key to access the Sandbox as a Developer and join the Google Group forum and mail list for the "FamilySearch Developer Network"
3. Learn and Use API on the Sandbox
We have provided documentation and software to help you learn and harness the powerful capabilities of the FamilySearch API. You may also wish to use a Third-party Library to help you get started with your language of choice.
How Do I Certify My Product?
By completing the following steps, you will be able to certify your product and gain access to the API Production System with an application key.
1. Apply to be a Software Partner
Becoming a Software Partner will bring you benefits of additional support and company promotion. The application process is simple.
- [ Application instructions ] ( partnering-app-instructions.md )
- [ Current certified products ] ( http://www.familysearch.org/products )
2. Certified Application Features
Certifying your application is your last step to obtaining a developer key and gaining access to the API Production System. As you develop your application, please review the certification requirements that you will need to comply with in order for your product to become certified.
Product certification is the process of certifying that a certain product has passed performance and quality assurance requirements stipulated by the certifying entity. FamilySearch has chosen to certify minimum requirements for different sets of features to make it easier for consumers to understand what a vendor may or may not be offering. The categories for applications and utilities that can be certified are Tree Share + App, Tree Connect App, Tree Connect Utility, and Tree Access Utility.
Required: Yes Not Allowed: No Optional: Opt
|Authentication||Share + App||Connect App||Connect Util||Access|
|Basic (desktop and mobile)||Yes||Yes||Yes||Yes|
|oAuth 2 (Web apps)||Yes||Yes||Yes||Yes|
|Person Merge (Optional for mobile Share apps)||Yes||No||No||No|
|Tree Interface Scenarios||Yes||No||No||No|
|Collaboration ( the "+" )|
|Sources Descr: Read||Yes||Yes||Opt||Opt|
|Sources Descr: write||Yes||Yes||Yes||Opt|
|Sources Ref: Read||Yes||Yes||Opt||Opt|
|Sources Ref: Write||Yes||Yes||Opt||Opt|
|Integration of Community Activity (minimum Person Detail)||Yes||No||No||No|
|Programmatic Match between local and FS Trees||Yes||Yes||Opt||Opt|
|Standards and Authorities|
|Read Date, Name, and Place Standards||Yes||Opt||Opt||Opt|
Tree Share + Application
FamilySearch family tree is at the heart of the purpose of FamilySearch. The growth and quality of the tree is dependent on the engagement of users with tools, resources, and services that facilitate cooperative contributions. A Tree Share Application is designed to encourage collaboration before, during, and after viewing, adding, or editing the shared tree. Any contribution should be supported by the proper evidence, and if possible, linked to an online image of the source. A Tree Share Application is using the features of FamilySearch API as outlined below. Since this application is writing conclusions and making updates to the tree, it is required to adopt the collaboration toolset and a supporting user interface.
Tree Connect Application
Media is often kept by an individual or a family. Media may include documents, journals, books, stories, photos, audio, or video. Tree Connect applications or utilties may digitally assist in the creation, design, digitalization, conversion, preservation, or sharing of family media. An official Media Connection Client or Tool also easily connects media to deceased persons in FamilySearch Family Tree that resides in a local application, FamilySearch historical data, or other media on the web. A Tree Connect application is using the features of FamilySearch API as outlined below. Since this application is writing sources, it is required to adopt a portion of the collaboration toolset and supporting user interface.
Tree Connect Utility
A Tree Connect Utility is using the features of FamilySearch API as outlined below. Since this application is writing sources, it is required to adopt a portion of the collaboration toolset and supporting user interface.
Tree Access Utility
A Tree Access Utility reads Familysearch Family Tree in order to generate special analysis, reporting, visualization, or printing capabilities. Some of these current and proposed utilities read the family tree to find data problems, persons lacking information, or persons ready or near ready for ordinance submission. Other tools were created to make it easier to generate and print a variety of family charts. A Tree Access Utility is using the features of the FamilySearch platform as outlined below. Since this utility is only reading the tree for analysis, visual display, or printing, it is not required to use any of the collaboration toolset.
The application is written with support for Unicode (such as UTF8, double-byte characters) and has a configurable setup for UI and complete messaging for multiple languages. UI, messaging, and help translations can be easily created by developers or users and be integrated and distributed by the partners or developers.
- The application is Tree Share certified.
- The application follows the instructions in the PAF SDK to read PAF 5.2 files and write persons and person events into the application for uploading to FamilySearch Family Tree.
- API License Agreement (pdf)
- Certified Web Services Agreement (pdf)
- FamilySearch Center Affiliate Agreement (pdf)
- FamilySearch Trademark and Logo Guidelines (pdf)
Forms and Applications
- App Certification Application (MS Word Doc)
- Utility Certification Application (MS Word Doc)
- Application Key Request and Use Agreement (MS Word Doc)
Logos and Artwork
FamilySearch Logo (available in color postscript format, JPG format, or PNG format, and gray PNG format)
FamilySearch Certified Logo (available in color postscript format or PNG format, black PNG format, and brown PNG format)
Tree Icons (available in large color PNG format and medium/small PNG formats in colors shown)
The Tree icons that can be used within a mobile, desktop, or web applications. These icons are not to replace the use of the FamilySearch Logo nor the FamilySearch Certified Logo. They are only to be used for programmatic functions within the applications including making calls to the FamilySearch API including authentication. They are not to be used as Favicons or Links to www.familysearch.org, new.familysearch.org, or any other pages on a FamilySearch website. The tree on these icons cannot be put on buttons with other words. These graphical icons needs to remain as a 16 x 16 or 32 x 32 graphic in its entirety.
FamilySearch Temple Status Icons (black temple icon shown is available in multiple sizes)
FamilySearch Artwork (Complete set of files available for download in ZIP format)