Versioning

API Changelog

About

Below is a log of changes to the Persona API. Updates that affect only products or features in beta or limited release may not be reflected.

Each change can be described as either a breaking change or an ongoing change.

  • Breaking changes = new API version: When we make any backwards-incompatible changes, we release a new version of the API. In addition to being assigned a new API version, these changes are marked in the changelog with the 💥 symbol. You’re in charge of when you get breaking changes—you get them when you upgrade your API version. Learn how to try out and upgrade to newer API versions.
  • Ongoing changes: Ongoing changes are backwards-compatible, and are added on an ongoing basis. You don’t need to update your API version to get these updates.

Key

🌱 New feature

🍃 Improvement

🔧 Fix

💥 Breaking change

🔒 Security-related

August 21, 2023

Inquiries

  • 🌱 inquiry-template now included when retrieving an Inquiry: Retrieving an Inquiry will now return the related inquiry-template within included. It contains fields: status and name along with a relationship latest-published-version. You can compare it with the inquiry’s inquiry-template-version ID to determine if the inquiry is up to date with the latest version of the template.

Reports

  • 🌱 Corporate Registration Addresses in Business Lookup Report: Business Lookup Reports now include a list of addresses associated with the business. The addresses will also include a type that will be one of the following values: site, registered_business_address, mailing, or registered_agent.