GuidesAPI ReferenceDiscussions
HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceDiscussions
Back to All

v5.0.0

about 2 years ago by ReadMe API

Summary

This version of the API includes enhancements as well as breaking changes to a few of our endpoints.
Please see the Upgrade Guide for detailed information on how to upgrade your code for v5.0.0.

Close API

Breaking Changes

  • New schema for POST /close/closings/:id/enote endpoint in this version. This endpoint now allows you to generate, view, and sign an ENote either with EOriginal or DocMagic vault providers. Please get in contact with your Blend Customer Success Manager if you would like to learn more about how to enable enotes for your institution.
  • Added the packageReferences property to the GET /close/closings and GET /close/closings/{id} endpoints. Currently returns info about the esign package.

Consumer Lending API

Non-Breaking Changes

  • Applications Endpoints
    • Added the autopayFromChecking property to the response for the GET /consumer-lending/applications/{id} endpoint.
    • Added the employerSEGCode property to the borrowers[].employers[] within the response body for the GET /consumer-lending/applications/{id} endpoint.
    • Added spouseAddress, firstName, middleName, lastName and suffixName properties and made indicator optional for the declarations schema for the GET /consumer-lending/applications/{id} endpoint.
    • Added the productId property for all loan types (not just Credit Card) for the GET /consumer-lending/applications/{id} endpoint.
    • Added the source property to GET /consumer-lending/applications/{id}/decision endpoint and decision object of GET /consumer-lending/applications/{id}/ endpoint.
    • Added the inLenderNetwork and newRentalLease properties to the GET /consumer-lending/applications/{id}/ endpoint.
    • Added the applicationStatus property to the GET /consumer-lending/applications/{id}/ endpoint.

Home Lending API

Non-Breaking Changes

  • Applications Endpoints

    • Added ignoreArchivedStatus as a new query parameter to GET /home-lending/applications endpoint.
    • The value DENIED may be used in all los-milestones endpoints if the tenant is configured to accept it. This affects the following:
      • POST /home-lending/applications/los-milestones in request body on fields with path losMilestones[].losMilestone
      • PATCH /home-lending/applications/{id}/los-milestones in request body under the field losMilestone
      • GET /home-lending/applications/{id}/los-milestones in the response body under the field name

  • Parties Endpoints

    • Added mailingAddress subobject to the request body for the POST /parties and PATCH /parties/:id endpoints

Lenders API

Non-Breaking Changes

  • New fields added
    • Added licensedStates to GET /lenders, POST /lenders, PUT /lenders. This field contains State Codes that represents which loans that a lender can be assigned to.

Packages API

Breaking Changes

  • POST /packages response: Changed the response from {'_id': 'packageId'} to {'id': 'packageId'}.
  • WETSIGN recipients metadata: Deprecated documentIds field and replaced with documents to be consistent with other provider types (e.g., ESIGN, REVIEW). This will affect the post request body for POST /packages as well as the responses for GET /packages and GET /packages/{id}.
  • ESIGN recipients metadata: Changed documents field to contain either tabs or tabExtractionMethod instead of both. This will affect the post request body for POST /packages as well as the responses for GET /packages and GET /packages/{id}.
  • Removed required from radio items in radio group tabs and added it to the attributes object of the radio group in the request body for POST /packages as well as the responses for GET /packages and GET /packages/{id}.

Non-Breaking Changes

  • New fields added
    • Added conditionalParentLabel and conditionalParentValue to radio group tabs in the request schema for POST /packages and response schemas for GET /packages and GET /packages/{id}.
    • Added conditionalParentLabel and conditionalParentValue to all tabs in the request schema for POST /packages and response schemas for GET /packages and GET /packages/{id}.
    • Added checkboxGroup tab in the request schema for POST /packages and response schemas for GET /packages and GET /packages/{id}.
    • Added deliveredDate, receivedIp, signedDate, signedIp, declinedDate, and declinedIp in the response schemas for GET /packages and GET /packages/{id}.

Reporting API

Breaking Changes

  • Deposit Account Applications Endpoint GET /reporting/deposit-account-applications
    • Deprecated response field coapplicantRejected and replaced with more accurately titled field coapplicantRejectedViaAan, which furthermore takes a null value instead of "false" if the coapplicant's information has not actually been submitted for IDV.

Non-Breaking Changes

  • Deposit Account Applications Endpoint GET /reporting/deposit-account-applications
    • Added 17 new response fields:
      • applicantSignupUrl
      • isSingleAppFlowApplication
      • prefillSourceApplicationId
      • prefillSourceApplicationType
      • firstMinorInfoWorkflowEventDatetime
      • firstIdvWorkflowSubmitDatetime
      • firstIdvWorkflowAdditionalInfoRequestedDatetime
      • hasBeneficiariesAdded
      • totalNumberOfFollowupsRequested
      • firstAutomatedRejectionSource
      • primaryApplicantRejectedViaAan
      • coapplicantRejectedViaAan
      • latestDecisionAutomatedRejectionSource
      • openingDepositSourceAccountConnectionMethod
      • openingDepositSourceAccountType
      • firstOnlineBankingRegistrationWorkflowEventDatetime
      • onlineBankingRegistrationCompletedDatetime
    • Note that the arrival of the "Automated Rejection Source" fields (firstAutomatedRejectionSource and latestDecisionAutomatedRejectionSource) is accompanied by methodology improvements behind the existing fields relating to automated rejections (firstAutomatedRejectionDatetime, latestDecisionDatetime, latestDecisionType, and latestDecisionOutcome), which now capture "system" rejections in addition to those returned by the IDV provider. See field descriptions for more detail on the distinction between rejection sources.

Authentication API

Non-Breaking Changes

  • Added a new endpoint, POST /oauth-token, that allows users to exchange their username and password for a
    short-lived (30 min) OAuth token that can be used as Bearer authentication on API requests. The motivation for adding
    this endpoint was to reduce the frequency with which customers must attach credentials to requests.

Application Events

Breaking Changes

  • Split application update events with trigger.type: EXPORTED into events with trigger.type: EXPORT and trigger.type: EXPORTED. Previously, initiating an application export in Blend or updating an application's losId through the API would cause an application update event with trigger.type: EXPORTED to be emitted. Under the new behavior,
    • application exports initiated in Blend will result in an application update event with trigger.type: EXPORT being emitted
    • updates to an application's losId through the API will result in an application update event with trigger.type: EXPORTED being emitted