API REFERENCE

View as Markdown

Beta

Known Issues

Current defects in how a staged loan is recorded. Each one is accepted without an error, or fails in a way the contract doesn’t describe. Each entry says what happens and what to send instead. An entry is removed when it is fixed.

A housing expense without presentHousingExpense fails with a 500

A housingExpense term that leaves out presentHousingExpense fails the whole request with a 500. It should be a 400 VALIDATION_ERROR.

Send "presentHousingExpense": true on every housingExpense term.

A proposed housing expense is not recorded

A housingExpense with "presentHousingExpense": false is accepted, and then dropped. Only the borrowers’ present expenses are recorded.

Send present expenses only. There is currently no way to stage a proposed one.

currentFirstMortgageHolderTypeOtherDescription is not recorded as sent

On a refinance term, the value recorded for currentFirstMortgageHolderTypeOtherDescription is taken from refinancePrimaryPurposeTypeOtherDescription, or, for an unrecognized currentFirstMortgageHolderType, from that value.

Don’t rely on this field until the issue is fixed.

An identifier of type Other is not recorded

An entry in participant.identifiers whose identifierType is not SSN, EIN or NMLS is dropped whole. That includes the documented value Other, and identifierOtherDescription is not used.

Send only SSN, EIN and NMLS identifiers.


Copyright © Pitchpoint Solutions. All rights reserved.