Blend Developer Portal

Welcome to the Blend developer portal. You'll find comprehensive guides and documentation to help you start working with Blend as quickly as possible, as well as support if you get stuck. You may also visit our public Github repository to download our OpenAPI specs directly. Let's jump right in!

Get Started    API Reference

v4.3.0

about a year 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. Added beneficiaries field to the top-level of response body. The top-level beneficiaries and account-level accounts[].beneficiaries share the same types of fields. Also, added the subType, email, dateOfBirth, socialSecurityNumber, entityName, taxpayerIdentificationNumber and phoneNumbers fields to top-level beneficiaries[] and account-level accounts[].beneficiaries[].
  • Added associatedApplicationId field to the response body of the GET /account-applications/:id endpoint.
  • Added customFields field to applicants and rejectedApplicants within the response body of the GET /account-applications/:id endpoint.
  • Added appSource field to metadata within the response body of the GET /account-applications/:id endpoint.
  • Added coreBankingId and customFields fields to applicants within the request body of the PATCH /account-applications/:id endpoint.
  • Added createdAt field to the response body of the GET /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 and customMetadata subobjects to the body.parties response for the GET /home-lending/applications endpoint.
    • Added the customFields and customMetadata subobjects to the body.parties field of the response body for the GET /home-lending/applications/:id endpoint.
    • Added the customMetadata subobject to the request body and the response body for the POST /home-lending/applications endpoint.
    • Added the customMetadata subobject to the request body for the PATCH /home-lending/applications/:id endpoint.
    • Added the customMetadata subobject to each of the records in the documents field of the response body for the GET /home-lending/applications/:id/documents endpoint.
    • Added the customFields and customMetadata subobjects to each of the records in the parties field of the response body for the GET /home-lending/applications/:id/parties endpoint.
  • Documents Endpoints

    • Added the customMetadata subobject to the response for the GET /documents endpoint.
    • Added the customMetadata subobject of the response body for the GET /documents/:id/metadata endpoint.
    • Added the customMetadata subobject to the request body and the response body for the POST /documents endpoint.
    • Added the customMetadata subobject to the request body for the PATCH /documents/:id endpoint.
  • Parties Endpoints

    • Added the customMetadata subobject to the request body for the PATCH /parties/:id endpoint.
    • Added the customMetadata subobject to the request body and the response body for the POST /parties endpoint.

Reporting API

Non-Breaking Changes

  • New endpoints

    • GET /reporting/deposit-account-applications
  • New fields added

    • Added loanNumber to GET /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 and los_milestone_last_updated_datetime to GET /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.

Lenders API

Non-Breaking Changes

  • Added email as a valid field in the lenders array for PATCH /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 the GET /home-lending/applications/:id endpoint.