GuidesAPI ReferenceBlend Help Center
HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceBlend Help Center
Changelog
Back to All

v9.0.0

12 months ago by ReadMe API

Summary

For guidance on how to upgrade your code to accommodate for the breaking changes in this version, please see the upgrade guide.

Documents API

Non-Breaking Changes

  • GET /documents/{id}/metadata

    • In the response, a new enumeration field 'source' has been added, which shows the source of the documents. Values are 'USER', 'DATA_PROVIDER'. This indicates whether they were uploaded by a user (USER) or via a data provider (DATA_PROVIDER).

  • POST /documents

    • In the response, a new enumeration field 'source' has been added, which shows the source of the documents. Values are 'USER', 'DATA_PROVIDER'. This indicates whether they were uploaded by a user (USER) or via a data provider (DATA_PROVIDER).

  • GET /documents

    • In the response, a new enumeration field 'source' has been added, which shows the source of the documents. Values are 'USER', 'DATA_PROVIDER'. This indicates whether they were uploaded by a user (USER) or via a data provider (DATA_PROVIDER).

Home Lending API

Non-Breaking Changes

  • GET /home-lending/applications/:id/documents
    • In the response, a new enumeration field 'source' has been added, which shows the source of the documents. Values are 'USER', 'DATA_PROVIDER'. This indicates whether they were uploaded by a user (USER) or via a data provider (DATA_PROVIDER).

Reporting API

Non-Breaking Changes

  • GET /reporting/deposit-account-applications

    • In the response, a new field 'membershipEligibilityType' has been added, which shows the membership eligibility reason chosen by an applicant when applying for one or more deposit account(s)

    • In the response, a new field 'latestConsumerPageName' has been added, a string of the title of the page most recently viewed by a applicant.

    • In the response, a new field 'productNames' has been added, a string listing the product description(s) of account(s) chosen by the applicant

  • GET /reporting/configurable-products-applications

    • In the response, a new field 'loanType' has been added, a string capturing the type of product for the application (e.g. ACCOUNT_OPENING, CREDIT_CARD). It is possible to filter data using this field.

    • In the response, a new field 'appLeadSource' has been added, a string capturing the type of user that created the application (e.g. BORROWER, LENDER).

    • In the response, a new field 'firstSubmitDatetime' has been added, a datetime of when the application was first submitted by an applicant or lender user. It is possible to filter data to applications submitted during a specified datetime.

    • In the response, a new field 'latestConsumerPageName' has been added, a string of the title of the page most recently viewed by an applicant.

    • In the response, a new field 'estLastUpdatedDatetime' has been added, the most recent timestamp of activity related to the application, namely node instance creation, node instance traversal, or field update date. It is possible to filter data to applications updated during a specified datetime.

    • In the response, a new field 'estArchivedDatetime' has been added, a timestamp when the application was archived. Field is appended with estimated, as this field is not meant to be used for compliance and reconciliation purposes. It is possible to filter data using a boolean of this field.

    • GET /reporting/activities

    • In the response, the following new fields have been added for additional borrower activities:

      • createdDatetime - a timestamp field in UTC for when the user was created. This is now also an optional request parameter
      • econsentDatetime - a timestamp field in UTC for when the user provided econsent
      • smsConsentStatus - a field for the status of econsent. Values include "DECLINED", "ACCEPTED", "PENDING", or "OTHER", and null
      • smsConsentDatetime - a timestamp field in UTC for when the SMS consent status was last updated

    • GET /reporting/lender-pab-activities

    • The following events have been added:

      • Previously, credit pull attempts that have been SKIPPED have been excluded from this report. These attempts will now show up.
      • Additionally, we now have an activityType for "adverse action check" for when AAN is attempted

    • In the response, the following new fields have been added around LO Toolkit and other automated activities:

      • creditPullstatus - contains additional detail around the status of the credit pull. Values include "FAILED", "SKIPPED", "SUCCESS", "OTHER" and null
      • adverseActionStatus - field for additional detail around AAN status. Values include "SUCCESS", "SKIPPED_FROZEN_CREDIT", "SKIPPED_MIN_CREDIT_SCORE_REACHED", "FAILED_TO_UPLOAD_DOCUMENT", "OTHER" and null

Close API

Non-Breaking Changes

  • Added a new endpoint PUT /close/closings to upsert a closing.

  • GET /close/closings/:id

    • In the response, a new enumeration field 'closingTypePreference' has been added, a string of the borrower's preferred closing option if they provided one.

GET /close/closings

  • In the response, for each closing a new enumeration field 'closingTypePreference' has been added, a string of the borrower's preferred closing option if they provided one.

  • PATCH /close/closings/:id

  • In the response, a new enumeration field 'closingTypePreference' has been added, a string of the borrower's preferred closing option if they provided one.

Follow-Ups API

Non-Breaking Changes

  • POST /follow-ups

    • For Tax Return followups, taxReturnYear is no longer required and nullable.
    • In the response, a new enumeration field 'requestSource' has been added. It can be either 'SYSTEM' or 'MANUAL' or 'API'.

  • GET /follow-ups

    • In the response, for each follow-up, a new enumeration field 'requestSource' has been added. It can be either 'SYSTEM' or 'MANUAL' or 'API'.

  • GET /follow-ups/:id

    • In the response, a new enumeration field 'requestSource' has been added. It can be either 'SYSTEM' or 'MANUAL' or 'API'.