v6.0.0

Summary

This version of the API includes enhancements as well as breaking changes to a few of our endpoints.

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

Close API

Non-Breaking Changes

• Add GET /home-lending/applications/:applicationId/closing-details public endpoint to get closing schedule details for all parties associated with application ID
• Add GET /home-lending/applications/:applicationId/parties/:partyId/closing-details public endpoint to get closing schedule details for a specific party ID associated with application ID
• Add PATCH /home-lending/applications/:applicationId/parties/:partyId/closing-details public endpoint to patch closing schedule details for a specific party ID associated with application ID

Loans API

Breaking Changes

• Home Lending Applications Endpoint GET /home-lending/applications/:applicationId and GET /home-lending/applications
  • Renamed nameId to username. We are renaming the field to standardize the naming convention of the unique identifier of the party that is passed to Blend during SSO login.

Non-Breaking Changes

• Added new tpr party types which may be used from 5.1.0 and higher
• Home Lending Applications Endpoint POST /home-lending/applications
  • Added a new request and response field, username - this field is the unique identifier of the party that is passed to Blend during SSO login.
• Home Lending Activities Endpoint GET /home-lending/applications/{id}/activities
  • Added a new optional field data in response. This field is used to provide verb-specific information in each activity.

Parties API

Non-Breaking Changes

• Parties Endpoint POST /parties and PATCH /parties/:partyId
  • Added a new request and response field, username - this field is the unique identifier of the party that is passed to Blend during SSO login.

Tax Transcripts Request API

Breaking Changes

• Restructured response schema to array of filing statuses

Reporting API

Non-Breaking Changes

• Configurable Products Applications Endpoint GET /reporting/configurable-products-applications
  • Added 2 new response fields:
    • applicationDeletionDatetime
    • applicationDeletionType
  • Added new date range request parameters corresponding to the new deletion datetime response field
• Lender PAB Activities Endpoint GET /reporting/lender-pab-activities
  • Added a new response field, ausProduct - this field distinguishes the AUS product used for the activity 'initated automated underwriting' (e.g. desktopUnderwriter, loanProductAdvisor)

Breaking Changes

• Lender PAB Activities Endpoint GET /reporting/lender-pab-activities
  • Renamed duRecommendation to ausRecommendation. We are renaming the field to reflect it more accurately, as this field includes all AUS run recommendations, not just DU

Account Opening API

Breaking Changes

• Update toGET /account-applications/:applicationId
  • Renamed samlUsername to username. We are renaming the field to standardize the naming convention of the unique identifier of the party that is passed to Blend during SSO login.

Incomes API

Non-Breaking Changes

• Added GET /income/verification/parties/:id/verified-data public endpoint to get income data verified through Blend Income for a specific party ID