Developer Guide
Back to DigiFi Homepage
Start typing to search…

API Changelog

The API Versions Changelog provides a comprehensive overview of changes introduced in different versions of our API. Stay informed about enhancements, new features, bug fixes, and any deprecations to ensure smooth integration and continued compatibility with our evolving API.


10/13/2025

GET /product-calculations

  • added the new optional 'query' request parameter 'count';
  • added the new optional 'query' request parameter 'offset';
  • added the new optional 'query' request parameter 'sortDirection';
  • added the new optional 'query' request parameter 'sortField';
  • added the required property '/items/createdBy' to the response with the '200' status;
  • added the required property '/items/updatedBy' to the response with the '200' status;

09/29/2025

GET /integration-result-files

  • for the 'query' request parameter 'count', default value '20 minimum 1' was added;
  • for the 'query' request parameter 'offset', default value '0 minimum 0' was added;
  • for the 'query' request parameter 'count', the max was set to '100.00';
  • deleted the 'query' request parameter 'filter';
  • deleted the 'query' request parameter 'sort';
  • added the new optional 'query' request parameter 'integrationResultId';
  • added the new optional 'query' request parameter 'sortDirection';
  • added the new optional 'query' request parameter 'sortField';
  • for the 'query' request parameter 'count', the type/format was generalized from 'number'/'' to 'string'/'';
  • for the 'query' request parameter 'offset', the type/format was generalized from 'number'/'' to 'string'/'';

09/29/2025

DELETE /comments/:id

  • added 'subschema #1, subschema #2' to the response body 'anyOf' list for the response status '200';
  • removed 'subschema #1, subschema #2' from the response body 'anyOf' list for the response status '200';

DELETE /tasks/:id

  • added 'subschema #1, subschema #2, subschema #3' to the 'externalAssignee/anyOf[subschema #1]/' response property 'anyOf' list for the response status '200';
  • removed 'subschema #1, subschema #2, subschema #3' from the 'externalAssignee/anyOf[subschema #1]/' response property 'anyOf' list for the response status '200';

GET /application-history

  • added the new optional 'query' request parameter 'executionContextReferenceId';
  • added 'subschema #1, subschema #2, subschema #3, subschema #4, subschema #5, subschema #6, subschema #7, subschema #8, subschema #9, subschema #10, subschema #11, subschema #12, subschema #13, subschema #14, subschema #15, subschema #16, subschema #17, subschema #18, subschema #19, subschema #20, subschema #21, subschema #22, subschema #23, subschema #24, subschema #25, subschema #26, subschema #27, subschema #28, subschema #29, subschema #30, subschema #31, subschema #32, subschema #33, subschema #34, subschema #35, subschema #36, subschema #37, subschema #38' to the 'items/items/' response property 'anyOf' list for the response status '200';
  • removed 'subschema #1, subschema #2, subschema #3, subschema #4, subschema #5, subschema #6, subschema #7, subschema #8, subschema #9, subschema #10, subschema #11, subschema #12, subschema #13, subschema #14, subschema #15, subschema #16, subschema #17, subschema #18, subschema #19, subschema #20, subschema #21, subschema #22, subschema #23, subschema #24, subschema #25, subschema #26, subschema #27, subschema #28, subschema #29, subschema #30, subschema #31, subschema #32, subschema #33, subschema #34, subschema #35, subschema #36, subschema #37, subschema #38' from the 'items/items/' response property 'anyOf' list for the response status '200';

GET /comments

  • added 'subschema #1, subschema #2' to the '/items/' response property 'anyOf' list for the response status '200';
  • removed 'subschema #1, subschema #2' from the '/items/' response property 'anyOf' list for the response status '200';

GET /decisions/:id

  • added the optional property 'results/items/modulesProcessingResults/items/anyOf[subschema #4]/filesResponse' to the response with the '200' status;

GET /tasks

  • added 'subschema #1, subschema #2, subschema #3' to the 'items/items/externalAssignee/anyOf[subschema #1]/' response property 'anyOf' list for the response status '200';
  • removed 'subschema #1, subschema #2, subschema #3' from the 'items/items/externalAssignee/anyOf[subschema #1]/' response property 'anyOf' list for the response status '200';

GET /tasks/:id

  • added 'subschema #1, subschema #2, subschema #3' to the 'externalAssignee/anyOf[subschema #1]/' response property 'anyOf' list for the response status '200';
  • removed 'subschema #1, subschema #2, subschema #3' from the 'externalAssignee/anyOf[subschema #1]/' response property 'anyOf' list for the response status '200';

GET /tasks/search

  • added 'subschema #1, subschema #2, subschema #3' to the 'items/items/externalAssignee/anyOf[subschema #1]/' response property 'anyOf' list for the response status '200';
  • removed 'subschema #1, subschema #2, subschema #3' from the 'items/items/externalAssignee/anyOf[subschema #1]/' response property 'anyOf' list for the response status '200';

POST /application-decision-processing

  • added the optional property 'result/modulesProcessingResults/items/anyOf[subschema #4]/filesResponse' to the response with the '200' status;

POST /application-integration-processing

  • added the optional property 'filesResponse' to the response with the '200' status;

POST /comments

  • added 'subschema #1, subschema #2' to the response body 'anyOf' list for the response status '201';
  • removed 'subschema #1, subschema #2' from the response body 'anyOf' list for the response status '201';

POST /decision-processing

  • added the optional property 'results/items/modulesProcessingResults/items/anyOf[subschema #4]/filesResponse' to the response with the '200' status;

POST /tasks

  • added 'subschema #1, subschema #2, subschema #3' to the 'externalAssignee/anyOf[subschema #1]/' response property 'anyOf' list for the response status '201';
  • removed 'subschema #1, subschema #2, subschema #3' from the 'externalAssignee/anyOf[subschema #1]/' response property 'anyOf' list for the response status '201';

POST /tasks/batch

  • added 'subschema #1, subschema #2, subschema #3' to the '/items/externalAssignee/anyOf[subschema #1]/' response property 'anyOf' list for the response status '200';
  • removed 'subschema #1, subschema #2, subschema #3' from the '/items/externalAssignee/anyOf[subschema #1]/' response property 'anyOf' list for the response status '200';

PUT /comments/:id

  • added 'subschema #1, subschema #2' to the response body 'anyOf' list for the response status '200';
  • removed 'subschema #1, subschema #2' from the response body 'anyOf' list for the response status '200';

PUT /tasks/:id

  • added 'subschema #1, subschema #2, subschema #3' to the 'externalAssignee/anyOf[subschema #1]/' response property 'anyOf' list for the response status '200';
  • removed 'subschema #1, subschema #2, subschema #3' from the 'externalAssignee/anyOf[subschema #1]/' response property 'anyOf' list for the response status '200';

09/15/2025

DELETE /application-documents/:id

  • added the optional property 'taskIds' to the response with the '200' status;

DELETE /comments/:id

  • added 'subschema #1, subschema #2' to the response body 'anyOf' list for the response status '200';
  • removed 'subschema #1, subschema #2' from the response body 'anyOf' list for the response status '200';

GET /application-documents

  • added the new optional 'query' request parameter 'taskIds';
  • added the optional property '/items/taskIds' to the response with the '200' status;

GET /application-documents/:id

  • added the optional property 'taskIds' to the response with the '200' status;

GET /application-history

  • added 'subschema #19, subschema #20, subschema #21' to the 'items/items/' response property 'anyOf' list for the response status '200';

GET /applications/:id/variables

  • api tag 'Application API Methods' added;
  • api tag 'Borrower Portal Authentication API Methods' removed;

GET /comments

  • added 'subschema #1, subschema #2' to the '/items/' response property 'anyOf' list for the response status '200';
  • removed 'subschema #1, subschema #2' from the '/items/' response property 'anyOf' list for the response status '200';

POST /application-documents

  • added the optional property 'taskIds' to the response with the '201' status;

POST /application-documents/batch

  • added the optional property '/items/taskIds' to the response with the '201' status;

POST /application-documents/document-folders

  • added the optional property 'taskIds' to the response with the '201' status;

POST /application-documents/tasks-link

  • endpoint added;

POST /application-documents/tasks-unlink

  • endpoint added;

POST /comments

  • added 'subschema #1, subschema #2' to the response body 'anyOf' list for the response status '201';
  • removed 'subschema #1, subschema #2' from the response body 'anyOf' list for the response status '201';

PUT /application-documents/:id

  • added the optional property 'taskIds' to the response with the '200' status;

PUT /comments/:id

  • added 'subschema #1, subschema #2' to the response body 'anyOf' list for the response status '200';
  • removed 'subschema #1, subschema #2' from the response body 'anyOf' list for the response status '200';

09/01/2025

DELETE /application-documents/:id

  • added the optional property isThumbnailAvailable to the response with the 200 status;

GET /application-documents

  • added the optional property /items/isThumbnailAvailable to the response with the 200 status;

GET /application-documents/:id

  • added the optional property isThumbnailAvailable to the response with the 200 status;

GET /application-documents/thumbnails

  • endpoint added;

POST /application-documents

  • added the optional property isThumbnailAvailable to the response with the 201 status;

POST /application-documents/batch

  • added the optional property /items/isThumbnailAvailable to the response with the 201 status;

POST /application-documents/document-folders

  • added the optional property isThumbnailAvailable to the response with the 201 status;

PUT /application-documents/:id

  • added the optional property isThumbnailAvailable to the response with the 200 status;

07/21/2025

DELETE /applications/:id

  • added the required property status/color to the response with the 200 status;

GET /application-statuses

  • added the new optional query request parameter types;
  • for the query request parameter productId, the type/format was generalized from string/ to /;

GET /applications

  • added the required property items/items/status/color to the response with the 200 status;

GET /applications/:id

  • added the required property status/color to the response with the 200 status;

GET /applications/search

  • added the required property items/items/status/color to the response with the 200 status;

GET /decisions/:id

  • added the required property results to the response with the 200 status;

POST /applications

  • added the required property status/color to the response with the 201 status;

POST /applications/:id/labels

  • added the required property status/color to the response with the 200 status;

POST /applications/:id/run-calculations

  • added the required property status/color to the response with the 200 status;

POST /applications/:id/team-members

  • added the required property status/color to the response with the 200 status;

PUT /applications/:id

  • added the required property status/color to the response with the 200 status;

PUT /applications/:id/coborrowers

  • added the required property status/color to the response with the 200 status;

PUT /applications/:id/intermediary

  • added the required property status/color to the response with the 200 status;

07/07/2025

GET /labels

  • endpoint added;

05/09/2025

Metadata field introduction

All resources below now include an optionalmetadata object

LimitDescription
≤ 20 pairsUp to twenty key–value pairs per object
Key ≤ 40 charsAlphanumeric (plus _ / -)
Value typesstring (≤ 500 chars) · number · boolean

Metadata patch semantics (metadata update)

  • Modify up to 40 keys in a single patch.
  • Remove a single entry with "yourKey": null.
  • Reset the entire object with metadata: null (equivalent to {}).

Affected resources

metadata is now present on:

  • Borrower
  • Intermediary
  • Application
  • Application Task
  • Application Document

Affected APIs

02/06/2025


12/16/2024


11/25/2024


10/17/2024

  • Upload Of Integration Files API was added (Documentation)
  • The files field was added to Run Integration request to run integration with files.
  • The files field was added to Run Decision request to run decisions that has integrations that require files.

09/18/2024

09/02/2024

  • Added strategyId field in Application Events for application.decisionProcessed event data.

08/19/2024

08/06/2024

  • Task Comment object have been changed:
    • The referenceType field support has been removed (referenceType field will be populated to object for backwards-compatibility).
    • The referenceId field has been renamed to taskId (referenceId field will be populated to object for backwards-compatibility).
    • The applicationId field has beed added.
    • The productId field has beed added.
  • Updates to Create Task Comment body parameters include:
    • The referenceType field has been removed.
    • The referenceId field has been renamed to taskId (referenceId field will be supported for backwards-compatibility).
  • Search Task Comments query parameters have been changed:
    • referenceType query attrbiute has been removed.
    • referenceId query attribute has been renamed to taskId (referenceId query attribute will be supported for backwards-compatibility).

07/22/2024

07/02/2024

⚠️

Important Note!

https://cloud.digifi.io/v2/_/api and https://sandbox.digifi.io/v2/_/api are marked as deprecated and will be removed soon with short notice.

⚠️

Important Note!

The https://api.cloud.digifi.io and https://api.sandbox.digifi.io API URLs do not support trailing slashes. For example, a request to https://api.cloud.digifi.io/applications/ (GET) will fail with a 404 status code, but https://api.cloud.digifi.io/applications will pass.

Legacy endpoints https://cloud.digifi.io/v2/_/api and https://sandbox.digifi.io/v2/_/api will retain support for trailing slashes for backwards compatibility.

06/10/2024

04/03/2024

03/07/2024

  • A new event type externalIntegration.processed was added to the Webhooks. It occurs when external integration is processed.

02/26/2024

  • A new API version, 2024-02-26 (read API Versions), has been released to accommodate changes to tasks functionality.
  • All list endpoints will default the count value to 20 if it is not specified.
  • A query parameter identifierType has been added to the Get Application endpoint, enabling search functionality by displayId.
⚠️

Important Note!

The changes outlined below apply exclusively to the API version released on 2024-02-26. Earlier API versions will continue to function as normal without these modifications.

However, we recommend upgrading to the latest API version to benefit from the new task functionalities and accelerate your requests. DigiFi will continue to support previous versions for a limited time but will eventually discontinue support, providing prior notice before doing so.

Additionally, the updates introduce updated, added, and removed fields to the task resource. To ensure compatibility with both new and old versions, we are passing both new and old fields to webhook endpoints that listen for task.created, task.updated, task.deleted events.

  • Task Object attributes have been changed:
    • The application field has been removed (use applicationId or applicationDisplay instead).
    • The assignedBorrowerField and assignedIntermediary fields have been removed (use externalAssignee instead).
    • The description field has been removed (use title instead).
    • The blockedStatuses field has been removed (use blockedApplicationStatusIds instead).
    • The dueDate field has been removed (use dueDateAndTime instead).
    • The assigneeType field has been removed (use externalAssignee.assigneeType instead).
    • The createdBy field has been removed (use createdById instead).
    • The updatedByfield has been removed (use updatedById instead).
    • The shouldSendAssignmentEmail field has been renamed to sendExternalAssignmentEmail.
    • A title field has been introduced.
    • An internalInstructions field has been introduced.
    • An externalInstructions field has been introduced.
    • An externalAssignee field has been introduced.
    • A blockedApplicationStatusIds field has been introduced.
    • An applicationId field has been introduced.
    • A productId field has been introduced.
    • An applicationDisplayId field has been introduced.
    • A version field has been introduced.
    • An assignedTeamMemberIds field has been introduced.
    • A dueDateAndTime field has been introduced.
    • A labelIds field has been introduced.
  • Search Application Tasks has been moved to the /search endpoint.
  • Search Application Tasks has transitioned to an eventual consistency model.
  • Search Application Tasks query parameters have been changed:
    • The assigneeId query attribute has been removed (use externalAssigneeId or assignedTeamMemberIds instead).
    • The assigneeType query attribute has been removed (use externalAssigneeType instead).
    • The notInStatus query attribute has been removed.
    • The teamMembersIds query attribute has been removed.
    • assignedTeamMembersIds has been renamed to assignedTeamMemberIds.
    • dueUpdatedDateFrom and dueUpdatedDateTo have been renamed to updatedDateFrom and updatedDateTo, respectively.
    • An externalAssigneeId query attribute has been introduced (optional).
    • An externalAssigneeType query attribute has been introduced (optional).
    • A productId query attribute has been introduced (optional).
    • A labelIds query attribute has been introduced (optional).
    • The count parameter is now limited to a maximum of 100.
  • A List Application Tasks endpoint has been introduced.
  • Updates to Create Application Task body parameters include:
    • The description field has been removed (use title instead).
    • The assignee field has been removed (use assignedTeamMemberIds or externalAssignee instead).
    • The dueDate field has been removed (use dueDateAndTime instead).
    • shouldSendAssignmentEmail has been renamed to sendExternalAssignmentEmail.
    • blockedStatusesIds has been renamed to blockedApplicationStatusIds.
    • Required title field has been introduced.
    • Additional optional fields have been introduced: internalInstructions, externalInstructions, labelIds, assignedTeamMemberIds, externalAssignee, and dueDateAndTime.
  • Create Application Task validation logic has been changed to:
    • The system will now throw an error for any unrecognized variables within the variables field, moving away from the previous approach of sanitizing arrays.
    • The system will now throw an error for any unrecognized statuses within the blockedApplicationStatusIds (blockedStatusesIds in previous version) field, moving away from the previous approach of sanitizing arrays.
    • The variables array values are now limited to a maximum of 300 characters.
    • The group field is now limited to a maximum of 248 characters.
    • Introduce validation for all newly added fields.
  • Modifications have been made to the validation and attributes of Batch Create Application Tasks to ensure they match the specifications outlined in Create Application Task.
  • Changes to Update Application Task body parameters mirror those made for task creation, including similar adjustments to validation logic to ensure strict compliance with new field requirements and error handling protocols, aligning with the validation logic updates made for Create Application Task.

12/20/2023

12/01/2023

Our legacy API version refers to earlier iterations of the API that have since been superseded by more recent releases. While this version may still be functional, this is considered outdated and is no longer actively supported or updated.