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

Tags

  • πŸ’₯ Active tags limited to 1000 per organization: API requests that would result in additional tags being created will receive 422 response code if the organization has at least 1000 tags currently active.

Verifications

  • πŸƒ Add non-domiciled to the list of possible ID designations: non-domiciled is now among the list of possible ID designations.



Verifications

  • πŸƒ Add account relationship to Verifications: Verification resources now include the related account in data.relationships. This allows you to determine which Account a given Verification is associated with directly from the response, without making an additional query.


Cross-API

  • πŸƒ Add page-count to File field schema: Responses that include field schemas with type FieldSchema::File will include the page count for newly created files or files with updated parent Persona object (Inquiry/Account/Transaction). Non-PDF format files will default to a page count of 1.

API Keys

  • πŸƒ Extend maximum file access token expiry to 3 days: API keys can now be configured (via the file-access-token-expires-in parameter) to return file URLs that have access tokens that are valid for up to 3 days. The previous maximum was 1 day. For more info, see Downloading Files.

Webhooks

  • πŸƒ Extend maximum file access token expiry to 3 days: Webhooks can now be configured (via the file-access-token-expires-in parameter) to return file URLs that have access tokens that are valid for up to 3 days. The previous maximum was 1 day. For more info, see Downloading Files.

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.