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 is not appropriate for read-after-write flows because the data is not immediately available to search.
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 live-human-presence) without exposing the underlying PII.
- Create a Relay returns the
relay-token,relay-secret, and session access token needed to redeem the claim. - Generate a Relay claim returns the claim payload. It is authenticated with a Privacy Pass token (RFC 9577) and requires the
Persona-Relay-Secretheader. - Create a Privacy Pass blind-signs a client-provided token (Blind RSA, RFC 9578) so it can be redeemed anonymously when generating a claim.
- Create a Relay returns the
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 endpoint.