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
Account Types and Case Templates
- 🌱 New endpoints to retrieve Account Types and Case Templates by ID: You can now retrieve a specific Account Type or Case Template by its public ID. Both responses include a
field-schemasarray underdata.attributes, where each entry describes one configured field (type,key,label,config) so you can programmatically validate that your application’s fields match what’s configured in Persona. The new endpoints require theaccount_type.readandcase_template.readpermissions, respectively. API keys created after the rollout date automatically include both permissions; API keys with explicit permission lists must addaccount_type.readand/orcase_template.readbefore they can call the new endpoints.
Filings
- 🔒 Filing endpoints now require the
filing.writepermission: Creating, updating, and adding objects to Filings now require API keys to have thefiling.writepermission. Existing API keys have been backfilled with this permission, and newly created API keys includefiling.writeby default. API keys with a narrow custom permission set must includefiling.writeto call these endpoints.

