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 theGET /close/closings
andGET /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 theGET /consumer-lending/applications/{id}
endpoint. - Added the
employerSEGCode
property to theborrowers[].employers[]
within the response body for theGET /consumer-lending/applications/{id}
endpoint. - Added
spouseAddress
,firstName
,middleName
,lastName
andsuffixName
properties and madeindicator
optional for thedeclarations
schema for theGET /consumer-lending/applications/{id}
endpoint. - Added the
productId
property for all loan types (not just Credit Card) for theGET /consumer-lending/applications/{id}
endpoint. - Added the
source
property toGET /consumer-lending/applications/{id}/decision
endpoint anddecision
object ofGET /consumer-lending/applications/{id}/
endpoint. - Added the
inLenderNetwork
andnewRentalLease
properties to theGET /consumer-lending/applications/{id}/
endpoint. - Added the
applicationStatus
property to theGET /consumer-lending/applications/{id}/
endpoint.
- Added the
Home Lending API
Non-Breaking Changes
-
Applications Endpoints
- Added
ignoreArchivedStatus
as a new query parameter toGET /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 pathlosMilestones[].losMilestone
PATCH /home-lending/applications/{id}/los-milestones
in request body under the fieldlosMilestone
GET /home-lending/applications/{id}/los-milestones
in the response body under the fieldname
- Added
-
Parties Endpoints
- Added
mailingAddress
subobject to the request body for thePOST /parties
andPATCH /parties/:id
endpoints
- Added
Lenders API
Non-Breaking Changes
- New fields added
- Added
licensedStates
toGET /lenders
,POST /lenders
,PUT /lenders
. This field contains State Codes that represents which loans that a lender can be assigned to.
- Added
Packages API
Breaking Changes
POST /packages
response: Changed the response from{'_id': 'packageId'}
to{'id': 'packageId'}
.- WETSIGN recipients metadata: Deprecated
documentIds
field and replaced withdocuments
to be consistent with other provider types (e.g., ESIGN, REVIEW). This will affect the post request body forPOST /packages
as well as the responses forGET /packages
andGET /packages/{id}
. - ESIGN recipients metadata: Changed
documents
field to contain eithertabs
ortabExtractionMethod
instead of both. This will affect the post request body forPOST /packages
as well as the responses forGET /packages
andGET /packages/{id}
. - Removed
required
from radio items in radio group tabs and added it to theattributes
object of the radio group in the request body forPOST /packages
as well as the responses forGET /packages
andGET /packages/{id}.
Non-Breaking Changes
- New fields added
- Added
conditionalParentLabel
andconditionalParentValue
to radio group tabs in the request schema forPOST /packages
and response schemas forGET /packages
andGET /packages/{id}
. - Added
conditionalParentLabel
andconditionalParentValue
to all tabs in the request schema forPOST /packages
and response schemas forGET /packages
andGET /packages/{id}
. - Added
checkboxGroup
tab in the request schema forPOST /packages
and response schemas forGET /packages
andGET /packages/{id}
. - Added
deliveredDate
,receivedIp
,signedDate
,signedIp
,declinedDate
, anddeclinedIp
in the response schemas forGET /packages
andGET /packages/{id}
.
- Added
Reporting API
Breaking Changes
- Deposit Account Applications Endpoint
GET /reporting/deposit-account-applications
- Deprecated response field
coapplicantRejected
and replaced with more accurately titled fieldcoapplicantRejectedViaAan
, which furthermore takes a null value instead of "false" if the coapplicant's information has not actually been submitted for IDV.
- Deprecated response field
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
andlatestDecisionAutomatedRejectionSource
) is accompanied by methodology improvements behind the existing fields relating to automated rejections (firstAutomatedRejectionDatetime
,latestDecisionDatetime
,latestDecisionType
, andlatestDecisionOutcome
), 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.
- Added 17 new response fields:
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 withtrigger.type: EXPORT
andtrigger.type: EXPORTED
. Previously, initiating an application export in Blend or updating an application'slosId
through the API would cause an application update event withtrigger.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 withtrigger.type: EXPORTED
being emitted
- application exports initiated in Blend will result in an application update event with