API Versions

Managing Breaking Changes in the DigiFi API

Your API version determines the API's functionality (like the properties visible in responses and the parameters you can include in requests). When a breaking change is introduced to the DigiFi API, we issue a new version dated accordingly. To prevent any disruptions to your existing code, we maintain your API version unchanged until you choose to update.

Backwards-compatible changes

DigiFi considers the following changes to be backwards-compatible:

  • Adding new API resources.
  • Adding new optional request parameters to existing API methods.
  • Adding new properties to existing API responses.
  • Changing the order of properties in existing API responses.
  • Adding new webhook event types.

Api Versions List

Below, you will find a list of all currently supported DigiFi API versions, along with a brief description of the changes. For detailed changes in each version, please refer to the API Changelog.

  • 2024-02-26 - This version introduces incompatible changes to the task resource.
  • 12/20/2023 - This version brings incompatible changes to the applications, borrowers, and intermediaries search API methods. With this update, the search API for these resources has become eventually consistent and has been relocated to the /search route. Additionally, a new method, list, has been introduced.
  • 12/01/2023 - This is the initial API version.