Blend API Docs

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.1.0

about a year ago by ReadMe API

Summary

This version of the api includes minor enhancements a few API's, including the Account Opening API. In addition, we've added a new overarching concept to the Public API, Custom Fields! This concept will be slowly extended to more and more resources as time goes on and provides a flexible way for customers to add custom tags to Blend resources and query based on the values of these custom tags. For more information, please see the Custom Fields user guide at https://developers.blend.com/blend/docs/custom-fields-on-resources.

Home Lending API

Non-Breaking Changes

  • Applications Endpoints

    • Added the loginMethod field to the body.parties response for the GET /home-lending/applications endpoint.
    • Added the custom_field_query query parameter to the GET /home-lending-applications endpoint. This query parameter allows you to pass in query filters of the format custom_field_query=custom_field_name=custom_field_value. If passed in, the endpoint will only return applications who have a custom field that satisfies the condition.
    • Added the createdBy subobject and the loginMethod field to the body.parties field of the response body for the GET /home-lending/applications/:id endpoint.
    • Added the customFields subobject to the request body and the response body for the POST /home-lending/applications endpoint.
    • Added the customFields subobject to the request body for the PATCH /home-lending/applications/:id endpoint.
    • Added the loginMethod field to the body.parties field of the response body for the GET /home-lending/applications/:id/parties endpoint.
    • Added the customFields 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 appSource field to the PATCH /home-lending/applications/:id endpoint request body.
    • Added the GET /home-lending/applications/employers/verified endpoint.
    • Added the POST /home-lending/applications/employers/reverify endpoint.
  • Documents Endpoints

    • Added the customFields subobject to the response for the GET /documents endpoint.
    • Added the custom_field_query query parameter to the GET /documents endpoint. This query parameter allows you to pass in query filters of the format custom_field_query=custom_field_name=custom_field_value. If passed in, the endpoint will only return applications who have a custom field that satisfies the condition.
    • Added the 'customFieldssubobject of the response body for theGET /documents/:id/metadata` endpoint.
    • Added the customFields subobject to the request body and the response body for the POST /documents endpoint.
    • Added the customFields subobject to the request body for the PATCH /documents/:id endpoint.
  • Parties Endpoints

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

Account Opening API

Non-Breaking Changes

  • Added rejectedApplicants and metadata fields to the response body of the GET /account-applications/:id endpoint.
  • Added employmentStatus and maritalStatus fields to applicants and rejectedApplicants within the response body of the GET /account-applications/:id endpoint.
  • Added the applicantRejected, applicationRejected and applicantReadyForDecisioning values to the enum for the body.integrationEvent.type field in the PATCH /account-applications/:id request body.
  • Added accessLimits to the PATCH /account-applications/:id request body.

Close API

Non-Breaking Changes

  • Added the POST /close/closings/{id}/external-enote endpoint. This endpoint allows you to add an ENote from a vault managed outside of Blend.
  • Added the PUT /close/closings/{id}/pre-closing-documents endpoint. This endpoint adds draft pre-closing documents to a closing or updates their document type if it has changed since their last addition.
  • Added the POST /close/closings/{id}/pre-closing-documents/send endpoint. This endpoint moves any pre-closing documents out of a draft state and sends them to the settlement agent.
  • Added 'scheduledCeremonyTimeandtimezoneto thePATCH /close/closings/:id` endpoint request body.

Reporting API

Non-Breaking Changes

  • Added borrower userAgent to borrowers endpoint