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

User Audit Logs

  • 🍃 Add response-status attribute to User Audit Logs: User Audit Logs resources now include a response-status attribute, which indicates the HTTP response of the request.
  • 🍃 Update get-params and post-params typing: User Audit Logs get-params and post-params attributes can now be a string in addition to an object.

Verifications

  • 🍃Add tags attribute to Verifications: Verifications resources now include tags that are associated with the verification.

Workflows

  • 🍃 Access workflow deployment and version details: You can now request the active-deployment and latest-published-version information via include when querying for a specific workflow.

Accounts

  • 🍃 Add max-file-size-bytes to File field schema: File field schemas now include a max-file-size-bytes attribute. This allows you to specify the maximum file size (in bytes) that can be uploaded for a given file field. The default is 10,000,000 bytes (10MB). This gives developers finer control over file uploads when designing templates and forms.

Inquiries

  • 🍃 Filter Inquiries by inquiry_id(s): You can now list inquiries withinquiry_id in the filter query parameter. There is a maximum of 100 inquiry_ids that can be passed in at a time.

Inquiries

  • 🍃 Track counts of requests from restricted API and SDK versions on Inquiries: Inquiry resources now include api-version-less-than-minimum-count and sdk-version-less-than-minimum-count under the behavior attribute.

Inquiry Sessions

  • 🍃 Add ip-isp and network-organization attributes to Inquiry Sessions: Inquiry Session resources now include ip-isp and network-organization string attributes collected from the network, if applicable.

Verifications

  • 🍃  New fields for VAT Number Verification: The VAT Number Verification now returns five new fields when you Retrieve a Verification. These fields are:

    • registered_address_street_1
    • registered_address_street_2
    • registered_address_city
    • registered_address_subidivision
    • registered_address_postal_code

Webhooks

  • 🌱 New endpoint for cloning a Webhook: You can now clone a Webhook by API.

API Keys

  • 🌱 New endpoint for cloning an API Key: You can now clone an API Key by API.

Inquiry Templates

Webhooks

  • 🍃Add name and description attributes to webhooks: webhook resources will now include a name and description attributes that can be optionally set.

Run History

  • 🔧 Update documentation for report Run History: The following run-history fields were always nullable, and are now marked as such in the documentation: scheduled-at, completed-at, report-template-version-id.

Verifications

  • 🍃 New defaults for Government ID Verification Template: Going forward, when you create a Government ID Verification, six new verification checks are enabled and required: id_age_comparison, id_age_comparison, id_color_inconsistency_detection, id_double_side_detection, id_fabrication_detection, id_tamper_detection, id_unprocessable_submission_detection. These defaults reflect what we find works best for most customers. These settings remain configurable.
  • 🍃 New defaults for Selfie Verification Template: Going forward, when you create a Selfie Verification, two new verification checks are enabled and required: selfie_face_covering_detection, selfie_suspicious_entity_detection. These defaults reflect what we find works best for most customers. These settings remain configurable.

Verifications

  • 🍃 Add from-reusable-persona attribute to Government ID and Selfie Verifications: Government ID and Selfie Verification resources now include a from-reusable-persona boolean attribute, which indicates whether or not the verification data was submitted via a Reusable Persona.