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.
Key
🌱 New feature
🍃 Improvement
🔧 Fix
💥 Breaking change
🔒 Security-related
Transactions
- 🌱 Add, remove, and set tag APIs for Transactions: We’ve added a new set of APIs for Transactions. The endpoints will let you add a tag, remove a tag, and set tags on Transactions. See the API reference guide.
Verifications
- 🌱 Redact Verification API: We’ve added a new API to redact a Verification. See the API reference guide.
Reports
-
🍃 Input fields in response for Adverse Media and Watchlist Reports: APIs and webhooks that return an Adverse Media or Watchlist Report will now include all the input fields for those reports. The new fields added per Report are:
-
Adverse Media Report
name-middle: String. Middle name from the input if one was provided, otherwise none.term: String. Combined name from input.birthdate: Date. Birthdate in ISO 8601 format (YYYY-MM-DD).country-code: String. The Alpha-2 country code from input.
-
Watchlist Report
name-first: String. First name from input.name-middle: String. Middle name from input if one was provided, otherwise none.name-last: String. Last name from input.term: String. Combined name from input.birthdate: Date. Birthdate in ISO 8601 format (YYYY-MM-DD).country-code: String. The Alpha-2 country code from input.
-