HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceDiscussions

v2.0.0 Upgrade Guide


For the complete and simple changelog see: v2.0.0 Changelog

This document is an extension of the changelog to give more context. It is for users of Blend's deprecated v1.3.0 APIs to help you understand:

  • Steps you will need to take over the next year to upgrade to v2.0 before the v1.3.0 functionality is fully deprecated and removed in October 2019
  • New features and functionality that are available to you as you begin using v2.0.0
  • Upcoming functionality in the experimental versions

Breaking Changes

This is the short list of what functionality has been deprecated as of v2.0. Deprecated means partners and customers need to start migrating off of these features over the next year, because in October 2019 we’re going to completely remove support for these features and it will break any integration still using them. See the API Release Process for more information on Blend's Deprecation Schedule.

  • Legacy Auth: Basic Authentication or BONS/Reporting-only credentials
  • 'X-Blend-Deployment and X-blend-special-instance-id Headers

Additionally the behavior of the following has been significantly changed.

  • Blend-API-Version Header
  • Dates and Timestamps

What You Need to Do

Blend-API-Version Header

  • Any customers using features that will remain experimental need to set the 'blend-api-version:’ header to ‘experimental’. See API Release Process for more info.
  • Any customers that have set their API version header to v2.0 will not experience any change in experience, unless they are using experimental features.
  • Customers that have not set a version header will automatically start using 2.0 when we deploy the v2.0 release. This could cause issues for them if their integration isn’t robust. For instance, we switch from using Unix timestamps in v1.3 to ISO timestamps in v2.0.
  • This will be the standard process for all releases going forward.

Legacy Auth: Using Basic Authentication or BONS/Reporting-only credentials

  • All Customers should get a new JWT-based API credential (ask Support) and begin migrating their integration to using this new auth.

X-Blend-Deployment and X-blend-special-instance-id Headers

  • These headers are used to tell Blend which tenant’s information you are trying to access if your API credentials have access to multiple tenants.
  • Customer should start using the blend-target-instance. This header uses exactly the same information as the previous two headers did, so the customer won’t need any new information. They just need to concatenate those same two pieces of information like blend-target-instance: deployment~specialinstanceid”

Dates and Timestamps

  • All dates and timestamps now use ISO formatting instead of Unix formatting they previously used
  • The following endpoints are affected:
    • POST /external/borrowers
    • PATCH /external/borrowers/:id
    • GET /external/documents
    • POST /external/documents
    • POST /external/loans

New Benefits of v2.0.0


We now support additional configurations while delivering disclosures via Docusign and Blend, and provide additional date and IP address fields on disclosures actions for tracking purposes.

Event Notifications

Blend's event notification service enables your customer and partner systems to ingest real-time updates from Blend that correspond to key actions with in the Blend platform. This service provides two core capabilities: generating events corresponding to key actions taken inside of Blend (e.g., application submit, eConsent update, document available), and a RESTful API to act on these events.

The Event Notification service can now be accessed by any user with an API token that has been granted the correct scopes. Contact your Account Manager or Partnerships Manager for more information or to expand your API access to include the Event Notification Service.

Reporting Endpoints

Blend's reporting endpoints provide programmatic access to reporting data on activity within Blend for internal and external users on the platform. This service gives you the ability to better measure Blend's performance and serves as an alternative to the deprecated Daily Analytics Package.

The API allows your organization to integrate with this data store in your preferred warehousing destination but also can serve data to existing BI or Analytics tools already leveraged internally. Contact your Account Manager for more information.

There are six endpoints within this service:

  • GET /reporting/documents: Retrieve which documents were created within Blend on each loan by whom and at what time. Documents can include: 1003, Bank Deposit Slip, 1099, HMDA Report, etc.
  • GET /reporting/loans: Retrieve loans created within Blend between two dates and the associated LOS key
  • GET /reporting/nps: Retrieve the NPS scores and associated comments for Blend loans
  • GET /reporting/activities: Retrieve activities associated with a Blend loan and the associated user which completed them. Activities can include: Taxes, Requested e-Consent, Submitted Application, etc.
  • GET /reporting/lenders: Retrieve lender users of Blend, what roles they hold within the organization, the loans they are associated with, and both their invited and activation times
  • GET /reporting/borrowers: Retrieve borrowers users within Blend, the loan they are associated with, and both their invited and activation times

Other New Endpoints

GET /loans/export-statuses

Get all records of when this loan has been exported.

GET /external/current-user

Check to make sure the API credentials you are using are valid.

Upcoming Experimental Functionality

The following functionality is being worked on in the upcoming Experimental version of the API. This functionality is not necessarily considered stable and has no SLAs for bugs or issues unless otherwise communicated. If you're interested in any of this functionality and would like to know more, contact your Account Manager or Partnership Representative.

  1. Lender Management Endpoints to be able to create loan officers users programmatically.
    • GET /external/lenders
    • POST /external/lenders
    • DELETE /external/lender
    • PATCH /external/lenders
  2. Account Applications endpoints to support new Account Opening workflows.
    • PATCH /external/account-applications/:id
    • GET /external/account-applications/:id