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.
SDK changelogs

Each Persona SDK has a separate changelog: Android SDK, iOS SDK, React Native SDK, Javascript SDK, Inlined React SDK, Inlined Vue SDK

Key

🌱 New feature

🍃 Improvement

🔧 Fix

💥 Breaking change

🔒 Security-related

Documents

  • 🍃 Stop backfilling extraction-responses into extraction-results: For API versions before 2021-08-18, the extraction-results attribute on Document responses was being synthetically computed from extraction-responses. This backwards-compatibility behavior has been removed. If you are on an API version before 2021-08-18 and rely on extraction-results, please use the extraction-responses attribute instead.

  • 🍃 Remove non-GET Document endpoint documentation: The create, update, and submit endpoints for Documents have been removed from the API reference. These endpoints are deprecated in favor of Transactions. The GET endpoints (retrieve and list) remain available.