Pearl Certification Developer Documentation

Offer Pearl Certifications to Your Customers

Pearl simplifies offering Pearl Certification to your users directly within your interface using our CTA Endpoint. This endpoint delivers a tailored payload of Call-to-Action data, guiding your users to seamlessly continue their home performance journey through the Pearl certification process.

Use Case

The Pearl CTA Endpoint supplies all the data you need to populate your chosen UI element. Below is the data format provided by the endpoint, demonstrating how seamlessly it integrates into a user-friendly Call-To-Action.

{
    "state": "Known - Not Certified"
    "heading": "Congrats! Your home has high performing features."
    "copy": "Did you know that homes marketed with Pearl Certification Reports earn an average premium of 5% compared to non-certified homes? Certify your home today and capture the hidden value in your home.",
    "cta_label": "Get Pearl Certified",
    "cta_url": "https://pearlcertification.com",
    "certification_unit_price": 99
}

An Example CTA UI Element

Why do I need this endpoint?

You might wonder why Pearl is determining the content for your Call-To-Action (CTA) element. While it’s possible to create your own copy, Pearl’s CTA Endpoint does more than just provide text.

In the background, the endpoint performs a comprehensive analysis of the available home performance data for the property. It then delivers relevant information tailored to that home, ensuring the user is directed to the right certification processing workflow based on the unique features of their property.