Summary

For guidance on how to upgrade your code to accommodate for the breaking changes in this version, please see the upgrade guide.

Home Lending API

Non-Breaking Changes

POST /home-lending/applications/{id}/take-over
- Added a new endpoint to support lender take over via public API
Changes in GET /home-lending/applications, GET /home-lending/applications/:id, GET /home-lending/applications/:id/parties
- Added 'smsConsent' object along with party information in the response
- 'smsConsent' object has the following nested fields
  - 'status' could be 'PENDING/ACCEPTED/DECLINED'
  - 'recipientPhoneNumber' phone number which consented for SMS notifications
  - 'paused' whether SMS notifications are paused
  - 'date' UTC timestamp of when consent was given by user
  - 'ip' IP Address from which consent was given
- 'smsConsent' object would be not included in the response for parties who have not provided consent
Changes in GET /home-lending/applications, POST /home-lending/applications, GET /home-lending/applications/:id, PATCH /home-lending/applications/:id, GET /home-lending/applications/:id/parties,
POST /parties, and PATCH /parties/:id
- Added support for 'province' and 'postalCode' for address objects under property and parties

Incomes API

Breaking Changes

Changes in GET /income/verifications?partyId=:partyId schema
- 'gseReference' field in now an array of objects. 'gseReference' also now supports a new 'vendorName'(TRWK)
- 'asOf', 'verifiedAt', 'employee', 'employment', 'payRate', 'yearlySummaries' are now optional fields in VerifiedIncome object
- 'payBasis', 'basePayFrequency' fields in VerifiedPayment objects are now optional

Reporting API

Non-Breaking Changes

GET /reporting/loans the following fields have been added in the response:
- propertySearchType - For lenders with Journey Chooser is enabled, this string field is set at the beginning of the application for where the borrower is at in their search (FOUND, NOT_IN_CONTRACT, NOT_STARTED, STILL_LOOKING)
- propertySearchTimeline - For lenders who have the purchase affordability flow for Mortgage (flagship data only), this string field indicates where the borrower is in their property search (0_TO_3_MONTHS, 3_TO_6_MONTHS, 6_TO_12_MONTHS, 12_MONTHS_OR_MORE, UNKNOWN)
- affordabilityOutcome - For lenders who have the purchase affordability flow for Mortgage (flagship data only), this string field indicates the status of the affordability outcome if the borrower reaches the end of the affordability workflow. If a user did not encounter the purchase affordability workflow, this field will be NULL. Otherwise, values include HIGH_DTI, VALID, LOW_AFFORDABILITY, LOW_CREDIT, DID_NOT_REACH_OUTCOME
GET /reporting/deposit-accounts-products - a new endpoint that returns one row per product for Consumer Deposit Account applications. The following fields have been added in the response:
- asOfDatetime - a UTC timestamp which shows the datetime of when the data was most recently refreshed.
- productId - the primary key of the table and the ID of the product object.
- applicationId - The UUID of the application in Blend's system. It is the static identifier that should be used to connect the application's identity across Blend and external integrations.
- productCreatedDatetime - UTC datetime of when the product object was first created.
- productType - a string field description for the type of product chosen by the applicant (e.g., CHECKING, CD, SAVINGS).
- productName - a string field name for the product chosen by the applicant (e.g., Essential Checking, 12-Month CD, Member Savings).
- productTerm - term for the product chosen by the applicant (e.g., 12).
- productBookingStatus - a strin field showing the booking status of the chosen product (e.g., BOOKED).
- productFundingStatus - a string field that is a string showing the funding status of the chosen product (e.g., PENDING_FUNDING).
- productFundingAmount - an integer showing the funding amount of the product chosen by the applicant.
- isOverdraftProtectionElected - a boolean showing if the applicant has elected overdraft protection for the chosen product.
- isBeneficiaryAdded - a boolean showing if a beneficiary has been added to the chosen product.
- isPhysicalCardSelected - a boolean showing if a physical card has been selected for the chosen product.
The following fields have also been added as optional request parameters:
- applicationId - this compares to the applicationId and will return data for that specific UUID
- productCreatedStartDate - An optional request parameter - compares to the productCreatedDatetime timestamp in UTC. When this is added, applications that were created after this parameter will be returned.
- productCreatedEndDate - An optional request parameter - compares to the productCreatedDatetime timestamp in UTC. When this is added, applications that were created before this parameter will be returned.

Parties API

Non-Breaking Changes

POST /parties/{id}/other-incomes an additional field has been added to the otherIncomes array in its request:
- description - This field is used to make explanation of a non-employment income. It can take a string value to describe the source of income.
Changes in PATCH /parties/{id}
- Third Party Recipient (TPR) party type changes are now allowed for updates between single-tenant types, now including NON_TITLE_SPOUSE, TITLE_HOLDER_TRUSTEE, and TITLE_HOLDER_SETTLOR_TRUSTEE.

Follow-Ups API

Non-Breaking Changes

POST /follow-ups - added support to create a follow-up task of type Home Insurance
- type - HOME_INSURANCE enum value is now supported
POST /follow-ups - added support to create a follow-up task of type Custom Question
- type - CUSTOM_QUESTION enum value is now supported
GET /follow-ups - added support to retrieve follow-up tasks of type Custom Question
- type - CUSTOM_QUESTION enum value is now supported in responses
GET /follow-ups/:id - added support to retrieve follow-up tasks of type Custom Question
- type - CUSTOM_QUESTION enum value is now supported in responses
PATCH /follow-ups/:id - added support to patch a follow-up task of type Home Insurance
- type - HOME_INSURANCE enum value is now supported
PATCH /follow-ups/:id - added support to patch a follow-up task of type Custom Question
- type - CUSTOM_QUESTION enum value is now supported

Guides

Changelog