v6.0.0 Upgrade Guide

PAB Activities (LO Toolkit) (GET /reporting/lender-pab-activities)

Breaking Changes

The response field duRecommendation has been renamed to ausRecommendation.

How to upgrade

Replace all references to the deprecated field name duRecommendation with the new field name ausRecommendation.

Home Lending Applications (GET /home-lending/applications and GET /home-lending/applications/:applicationId)

Breaking Changes

The response field nameId has been renamed to username.

How to upgrade

Replace all references to the deprecated field name nameId with the new field name username.

Account Opening (GET /account-applications/:applicationId)

Breaking Changes

The response field samlUsername has been renamed to username.

How to upgrade

Replace all references to the deprecated field name samlUsername with the new field name username.

GET /tax-transcripts Response

Breaking Changes

v3.3.0 returned a single object containing the most recent tax year(s) associated with the latest filing info:

{
  "years": [
    2019,
    2018
  ],
  "filingStatus": "SINGLE",
  "filingAddress": {
    "streetAddressLine1": "100 Main St",
    "streetAddressLine2": "Apt 10",
    "city": "Chicago",
    "state": "IL",
    "zipCode": "60007",
    "zipCodePlusFour": "1000"
  },
  "filers": [
    {
      "partyId": "592e17e5-0392-41e5-aca3-b0351914e60d",
      "name": {
        "firstName": "John",
        "middleName": "M",
        "lastName": "Doe",
        "suffixName": "III"
      }
    }
  ]
}

v6.0.0 introduces a new array taxTranscriptRequests contains filing detail objects that there previous returned at the top level. Exact matching filing details will be group together. A new name object previousName is added to the response with the introduction of Previous Name on the new IRS 4506C form. authorizedRepresentative is a new field on the IRS 4506C form and will always be false until when/if Blend supports this usecase.

{
  "taxTranscriptRequests": [
    {
      "years": [
        2019,
        2018
      ],
      "filingStatus": "SINGLE",
      "filingAddress": {
        "streetAddressLine1": "100 Main St",
        "streetAddressLine2": "Apt 10",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60007",
        "zipCodePlusFour": "1000",
        "countyName": "Cook County"
      },
      "filers": [
        {
          "partyId": "592e17e5-0392-41e5-aca3-b0351914e60d",
          "name": {
            "firstName": "Tanya",
            "middleName": "Marie",
            "lastName": "Williams"
          },
          "previousName": {
            "firstName": "Tanya",
            "middleName": "Marie",
            "lastName": "Williams"
          },
          "authorizedRepresentative": false
        }
      ]
    }
  ]
}

How to upgrade

Iterate on taxTranscriptRequests to capture filing details.