v2.3.0 Upgrade Guide
For the complete and simple Changelog see v2.3.0 Changelog
This document is an extension of the above Changelog that gives more context on these changes. It is for users of Blend's APIs to help you understand:
- Changes that impact the behavior of the API in this version
- New features and functionality that are available to you in v2.3.0
Don't forget that v1.X.X functionality will no longer be supported as of October 31st, 2019. Please see the previous Upgrade Guides for guidance on what you will need to change to make the transition to utilizing v2.0.0 or higher API version:
Final stable version before v1.0.0 final deprecation and v3.0.0 major release breaking changes
v2.3.0 will be the final stable version of the Blend API before all v1.0.0 functionality is fully deprecated and no longer supported by the Blend API.
The next stable release of the Blend API will be on October 31st, 2019 and will include breaking changes to the API's structure and its behavior. At this time, all v2.0.0 functionality will be marked as deprecated, meaning it will be fully removed and no longer supported as of October 31st, 2020 when v4.0.0 of the Blend API is launched.
Additional Benefits of v2.3.0
Verification Ref ID to support GSE Reps and Warrants Program
GET /loans/id/borrowers now includes the borrower Verification Reference Identifier, an ID that's mapped into Automated Underwriting Systems (AUS), which investors use to request source data from Blend. Verification Reference Identifiers update each time Blend collects new source data. It is important that AUS get the most up-to-date Verification Reference Identifier, and they can now get this data directly from Blend!
Underwriting Results Routes
We've exposed a new endpoint to enable integrators to pull down AUS run information on a Blend Loan Application. API Users can call GET /loans/id/underwriting-results with a specified loanId to pull all AUS runs associated with that loan.
Blend currently integrates with Fannie Mae's Desktop Underwriter (DU) AUS.
Employer and Income Routes
We've exposed a new set of routes to enable integrators to POST and GET Employer and Income information to and from a Blend Application. API Users can call POST /borrowers/id/employers and GET /borrowers/id/employers to sync this information between Blend and their additional integrations where it might live.
This functionality allows for more robust pre-fill of Blend Applications from CRM and other enterprise systems.
Additional Optional Fields Added to GET and PATCH /Loans
GET /loans (for a list of loans) and GET /loans/id (for an individual loan) will now include the applicationType field in the response object. Blend previously supported this field when Posting a Loan to Blend. We've now added this field to the GET endpoints to enable integrators to differentiate between "full" Applications and "post-submission only" Applications, and to drive conditional logic off of this distinction in their other enterprise systems, as certain functionality might be supported only for post-submission applications.
PATCH /loans/id will now allow the optional field estimatedClosingDate to be set, and GET /loans and GET /loans/id will now also include this optional field in the response object.
Additional Optional Fields Added to GET /loans/id/borrowers
GET /loans/:id/borrowers will now include an optional Addresses array for each Borrower in the response object. We've added this field to the GET endpoint to better support Blend's Borrower Sync operation, and to enable integrators to check if a Borrower's Address needs to be updated.
GET /loans/:id/borrowers will now also include an optional Credit object for each Borrower in the response object, if that Borrower's credit has been pulled. This object will include the credit provider's Credit Reference Number, the Date credit was pulled, and the Score as reported by each of the three major credit bureaus.
Updated almost 4 years ago