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
Accounts
🌱 Add endpoints to add and remove Account relations: You can now specify an object ID and relation key to control Account relations via the add relation endpoint and the remove relation endpoint.
Inquiries
🌱 Add endpoint to search Inquiries: You can now use complex queries to search for Inquiries via the search endpoint. Using search is a faster alternative to using the list all Inquiries endpoint. It…
Relays
🌱 Add new Relay API for privacy-preserving identity claims: You can now create a Relay and read its claim through the API. Relay returns an anonymized identity claim (such as age-over-18 or…
Transactions
🌱 Add endpoints to add and remove Transaction relations: You can now specify an object ID and relation key to control Transaction relations via the add relation endpoint and the remove relation…
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-schemas array under…
Filings
🔒 Filing endpoints now require the filing.write permission: Creating, updating, and adding objects to Filings now require API keys to have the filing.write permission. Existing API keys have been…
Inquiries
🍃 Add optional session tokens or one time links to Inquiry creation responses: The Inquiry create response can now return a session token or a one time link if you pass in certain flags. If you pass…
Reports
🍃 Add Instagram URL and username to Social Media Reports: The response attributes for Social Media Reports now include an instagram_url and instagram_username attribute to represent the linked…
Reports
🍃 Add position topics, start dates, and end dates to Politically Exposed Person Reports: The positions attribute in Politically Exposed Person Reports now exposes position topics as well as the…
Events
🍃 Add context attribute to Events and Webhook Events: Events and Webhook Event resources now include a context attribute that can hold additional information for certain event types. To start, the…
Accounts
🌱 Add endpoint to search Accounts: You can now use complex queries to search for Accounts via the search endpoint. Using search is a faster alternative to using the list all Accounts endpoint. It is…
Cases
🌱 Add endpoint to search Cases: You can now use complex queries to search for Cases via the search endpoint. Using search is a faster alternative to using the list all Cases endpoint. It is not…