HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceDiscussions

v3.3.0 Upgrade Guide


For the complete and simple summary of the changes below see the v3.3.0 Changelog.

This document is an extension of the above Changelog that gives more context on these changes. It is for users of Blend's APIs to help you understand:

  • Changes that impact the behavior of the API in this version
  • New features and functionality that are available to you in v3.3.0

Don't forget that v2.X.X functionality will no longer be supported as of March 31st, 2021.


New Disclosures Routes Added

In order to allow for better tracking we decided to fully embrace the envelopes concept. These envelopes are matched up to the tasks a borrower needs to complete in order to act on a set of documents. This allows for our lenders to track wet-sign, e-sign, and SSO-based transactions the same way. This means that API users will explicitly state what types of envelopes they want created, and be able to track recipient actions by envelope.

We changed the POST schema to be recipient-focused instead of document focused. This change was made because all SSO-based envelopes don't have documents. In order to keep the schemas consistent we chose to make the order package → envelope(s) → recipient(s) → metadata. Where metadata could be documents, documents with coordinates, or an SSO url.

We changed the POST API to be synchronous (all the previous versions are asynchronous). The new endpoints are as follows:

  • Added GET /packages
  • Added POST /packages
  • Added GET /packages/:id
  • Added PATCH /packages/:id

For more information on how to use these APIs see our guides
Creating a Document Package
Managing a Document Package

Tax Transcript Functionality Added

  • Added GET /tax-transcripts
  • Tax-transcript metadata added to GET /documents/:id/metadata

What You Need to Do to Upgrade to v3 or above

Getting Started with your Upgrade

v2.0.0-v2.3.0 of Blend's APIs and Events will be fully deprecated (turned off) on March 31st, 2021. Customers and Partners need to upgrade any API calls they are currently making and any webhooks they are processing to support v3.0.0 or above by March 31st, 2021.