Brand Certified Facts | Yext Hitchhikers Platform
A Brand Certified Fact is cryptographically signed proof that a given piece of data came from Yext (and thus the brand), and is valid as of a certain time. Having this on your page establishes authority and freshness, increasing trust with crawlers and leading to improved SEO and a higher likelihood of AI citations.
Brand Certified Facts can be automatically included in your page’s JSON-LD by enabling them in your template’s getHeadConfig definition. Once enabled, Pages will inject the certified-facts JSON snippet into the structured data for you.
Implementation Options
BCF can be implemented based on what type of Pages you have:
- New Pages (In-Platform): BCF is enabled automatically; no action is required.
- React Pages: Developers must add a code commit to the location template to support the signatures (instructions below). React customers managed by Yext will have BCF rolled out for free by the end of March.
- Content API: BCF is also available via the Content API for customers building pages outside of the Yext platform.
Customers building pages outside of the Yext platform can add BCF using the Content API. In-platform
0. Requirements
To use Brand Certified Facts, your Pages must:
- Be using PagesJS version ≥ v1.2.8
- Include at least one of the following core fields in the stream:
name,address,phone,websiteUrl,hours,categories,geo,emails,googleAttributes
1. Add Certified Facts Boolean to the Stream Config
See the Pages templates documentation for more information on editing streams templates in Pages.
Open the template file (e.g., src/templates/location.tsx) and update the stream property in the config object. Add the includeCertifiedFacts boolean property and set it to true to add certified facts to your Pages.
export const config: TemplateConfig = {
stream: {
$id: "locations",
fields: [
"id",
"name",
"address",
"mainPhone",
"description",
"slug",
],
filter: {
entityTypes: ["location"],
},
localization: {
locales: ["en"]
},
includeCertifiedFacts: true // add this property
},
};2. Add Certified Facts Script to the “Other” Key of getHeadConfig
Open the template file (e.g., src/templates/location.tsx) and add the certified facts script to the other key in the getHeadConfig object:
export const getHeadConfig: GetHeadConfig<TemplateRenderProps> = ({ document }): HeadConfig => {
const { name, description } = document;
return {
title: name,
charset: "UTF-8",
viewport: "width=device-width, initial-scale=1",
tags: [
{
type: "meta",
attributes: {
description
},
},
],
// add this line:
other: `<script type="application/ld+json">${JSON.stringify(data.document.__certified_facts)}</script>`
};
};3. Deploy & Verify
Commit your change and deploy your site.
Open a generated page and view the JSON-LD (via “View Page Source”)
- You should now see a
brandCertifiedFactsJSON snippet automatically added as a script tag in the <head> of your page.
- You should now see a