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

API version: v2021-08-18

Documents

  • 💥 Format of Generic Document responses: Generic Document responses will no longer include the extraction-results field. Use extraction-responses instead.

Inquiries

  • 💥 Format of Inquiry Session responses: Inquiry Session responses will no longer include the browser-fingerprint field. This value can now be found on the new device field under the top-level relationships field of a serialized Inquiry Session.