GuidesAPI ReferenceDiscussions
HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceDiscussions
Back to All

v4.2.0

about 2 years ago by ReadMe API

Summary

This version of the api includes minor enhancements to a few API's. We've added a few new fields to expose more of the data in Blend and also added new values to enums. We've also made some quality of life improvements to the structure of some of the API schemas. As this is a minor version release, there are no non-breaking changes included in this release.

Home Lending API

Non-Breaking Changes

  • Documents Endpoints
    • Added new property additionalEntities in the response body for the 'GET /documents/id/metadata. It is an object that contains a property accountOpeningApplicant that is an array of Applicant IDs

Account Opening API

Non-Breaking Changes

  • Slight changes to how Job Title and Employer are returned in the GET /account-applications/:id endpoint. If the employment status of the applicant is "unemployed", returns the previous Job Title and Employer
  • Added beneficiariesConsentIndicator field to the response body of the GET /account-applications/:id endpoint.
  • Added citizenshipStatus and sex fields to applicants and rejectedApplicants within the response body of the GET /account-applications/:id endpoint.
  • Added the type filed to applicants[].identityVerification and rejectedApplicants[].identityVerification within the response body of the GET /account-applications/:id endpoint.
  • Added the MINOR value to the enum for the applicants[].type field in the response body of the GET /account-applications/:id endpoint.
  • Added the PROVISIONAL_CREDIT value to the enum for the accounts[].accessLimits[].type field in the PATCH /account-applications/:id request body.

Packages API

Non-Breaking Changes

  • GET /packages returns a named object array instead of an array
  • POST /packages removed the fieldName attribute from all tab arrays

Users API

Non-breaking Changes

  • Lenders Endpoints
    • Added firstName and lastName to the response body for the GET /lenders endpoint.

Events API

Non-Breaking Changes

  • Events Endpoints
    • Added createdAt field in the response body of GET /events and GET /events/:id endpoints