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

July 15, 2021

API version: v2021-07-15

Inquiries

  • 💥 Format of Inquiry responses: Inquiry responses no longer include the reviewer field. You can now find this value in the new reviewer field under the top-level relationships field of a serialized Inquiry.

Verifications

  • 💥 Format of Database Verification responses: Database Verification responses no longer include the following fields: smarty-streets-address-street-1, smarty-streets-address-street-2, smarty-streets-address-city, smarty-streets-address-subdivision, smarty-streets-address-postal-code, smarty-streets-validation.
  • 💥 Format of Government ID Verification responses: The Government ID Verifications barcode_detection check now includes a new failure reason barcode_not_decoded. On older API versions, this failure reason serializes as the existing barcode_not_detected reason.