v4.3.0
over 2 years ago by ReadMe API
Summary
This version of the api includes minor enhancements to a few API's. In addition, we've added a new extension to the Custom Fields
framework, Custom Metadata
! This concept provides a flexible way for customers to add custom tags to Blend resources, and duplicate the same tag/tag value pairs across resources (which is disallowed for Custom Fields
). For more information, please see the user guide at https://developers.blend.com/blend/docs/custom-fields-on-resources.
Account Opening API
Non-Breaking Changes
- Some changes to how beneficiaries are returned in the
GET /account-applications/:id
endpoint. Addedbeneficiaries
field to the top-level of response body. The top-levelbeneficiaries
and account-levelaccounts[].beneficiaries
share the same types of fields. Also, added thesubType
,email
,dateOfBirth
,socialSecurityNumber
,entityName
,taxpayerIdentificationNumber
andphoneNumbers
fields to top-levelbeneficiaries[]
and account-levelaccounts[].beneficiaries[]
. - Added
associatedApplicationId
field to the response body of theGET /account-applications/:id
endpoint. - Added
customFields
field toapplicants
andrejectedApplicants
within the response body of theGET /account-applications/:id
endpoint. - Added
appSource
field tometadata
within the response body of theGET /account-applications/:id
endpoint. - Added
coreBankingId
andcustomFields
fields toapplicants
within the request body of thePATCH /account-applications/:id
endpoint. - Added
createdAt
field to the response body of theGET /account-applications/:id
endpoint.
Consumer Lending API
Non-Breaking Changes
- New endpoints
GET /consumer-lending/applications/{id}
PATCH /consumer-lending/applications/{id}
GET /consumer-lending/applications/{id}/documents
POST /consumer-lending/applications/{id}/decision
GET /consumer-lending/applications/{id}/decision
Home Lending API
Non-Breaking Changes
-
Applications Endpoints
- Added the
customFields
andcustomMetadata
subobjects to thebody.parties
response for theGET /home-lending/applications
endpoint. - Added the
customFields
andcustomMetadata
subobjects to thebody.parties
field of the response body for theGET /home-lending/applications/:id
endpoint. - Added the
customMetadata
subobject to the request body and the response body for thePOST /home-lending/applications
endpoint. - Added the
customMetadata
subobject to the request body for thePATCH /home-lending/applications/:id
endpoint. - Added the
customMetadata
subobject to each of the records in thedocuments
field of the response body for theGET /home-lending/applications/:id/documents
endpoint. - Added the
customFields
andcustomMetadata
subobjects to each of the records in theparties
field of the response body for theGET /home-lending/applications/:id/parties
endpoint.
- Added the
-
Documents Endpoints
- Added the
customMetadata
subobject to the response for theGET /documents
endpoint. - Added the
customMetadata
subobject of the response body for theGET /documents/:id/metadata
endpoint. - Added the
customMetadata
subobject to the request body and the response body for thePOST /documents
endpoint. - Added the
customMetadata
subobject to the request body for thePATCH /documents/:id
endpoint.
- Added the
-
Parties Endpoints
- Added the
customMetadata
subobject to the request body for thePATCH /parties/:id
endpoint. - Added the
customMetadata
subobject to the request body and the response body for thePOST /parties
endpoint.
- Added the
Reporting API
Non-Breaking Changes
-
New endpoints
GET /reporting/deposit-account-applications
-
New fields added
- Added
loanNumber
toGET /reporting/activities
,GET /reporting/borrowers
,GET /reporting/follow-ups
,GET /reporting/lender-pab-activities
,GET /reporting/nps
. This field represents the Loan Reference Number in the Blend Lender Workspace UI. - Added
los_milestone
andlos_milestone_last_updated_datetime
toGET /reporting/loans
. This is an optional enumerated field sent by lenders who have shared this data via the home-lending/applications/los-milestones endpoint in our public API, along with a timestamp for the most recent update received.
- Added
Lenders API
Non-Breaking Changes
- Added
email
as a valid field in the lenders array forPATCH /lenders
. This will update the user email for the lender user to the provided value. This is only available for SSO users. Note that you must submit a Blend Support request to enable the "Allow SSO lender email updates through API" configuration to enable this new field.
Home Lending API
Non-Breaking Changes
- Added
tridTriggeredDate
field to the response body of theGET /home-lending/applications/:id
endpoint.