V3 Manage Non-Borrowing Owners

patch

https://api.elliemae.com/encompass/v3/loans/nonBorrowingOwners/{loanId}

Add, update, delete, re-order, or replace non-borrowing owners for the loan, specified by the loan ID, if the user has access rights to the loan.

Usage Notes

See the following notes regarding each action query parameter value:

add - Do not provide “id”. It will be automatically generated.
update - The “id” is required to update the appropriate NBO record. Only properties that are provided in the request are updated.
delete - The “id” of the non-borrowing owner that you want to delete is the only property required.
reorder - Reorders the existing collection of non-borrowing owners. All non-borrowing owner “id’s” must be provided in the payload and in the order you want them, starting with the non-borrowing owner you want to appear first, and then so on.

❗️
KNOWN ISSUE
The “reorder” action is supported, but will remove the Vesting Information if sent. Please be aware of this issue. This will be resolved in a future release.

replace - Replaces all non-borrowing owners in the collection with non-borrowing owner provided in the request payload (i.e., deletes existing collection and then replaces with the non-borrowing owners provided in the request). New “id’s” are generated for the replaced non-borrowing owners.

Path Params

loanId

string

required

Unique identifier of the loan. Required.

Query Params

action

string

Available values: add, update, delete, reorder, replace

view

string

Optional. View type parameter. Enumerations: entity, id
When no view parameter is provided, the API will return 204 - No Content with no response body.

lockId

string

Lock indentifier.

includeEmpty

string

Empty fields can be retrieved by passing the query parameter includeEmpty=true.

Body Params

string

System-generated, unique identifier of the Non-Borrowing Owner (NBO) file contact. The NBO Record ID.

legacyId

string

Identifier from v1 Loan API loans (retrieve-only)

nonBorrowingOwnerIndex

integer

The index of the non-borrowing owner. The order in which the non-borrowing owners appear in Encompass. (retrieve-only)

firstName

string

NBO file contact first name

middleName

string

NBO file contact middle name

lastName

string

NBO file contact last name

suffixName

string

NBO file contact suffix name

addressStreet

string

NBO file contact street address

addressCity

string

NBO file contact city

addressState

string

NBO file contact state

addressPostalCode

string

NBO file contact postal code

borrowerType

string

Non-Borrowing Owner File Contact - Vesting Type. enums: Non Title Spouse, Title only, Title Only Trustee, Title Only Settlor Trustee

homePhoneNumber

string

NBO file contact home phone

string

NBO file contact email address

no3rdPartyEmailIndicator

boolean

Third-party email restriction indicator

businessPhoneNumber

string

NBO file contact business phone

cellPhoneNumber

string

NBO file contact cell phone

faxNumber

string

NBO file contact fax number

dateOfBirth

string

NBO file contact birth date (yyyy-MM-dd format)

borrowerVestingRecordId

string

Vesting record identifier (retrieve-only)

eSignConsentNbocStatus

string

eConsent status (service-to-service only)

eSignConsentNbocDateAccepted

string

eConsent acceptance date yyyy-MM-dd (service-to-service only)

eSignConsentNbocIpAddress

string

eConsent IP address (service-to-service only)

eSignConsentNbocSource

string

eConsent source designation (service-to-service only)

eSignConsentNbocDateSent

string

eConsent transmission date yyyy-MM-dd (service-to-service only)

foreignAddressIndicator

boolean

Non-U.S. address flag

country

string

NBO file contact country

homePhonePreferred

boolean

Home phone as preferred contact method

workPhonePreferred

boolean

Work phone as preferred contact method

cellPhonePreferred

boolean

Cell phone as preferred contact method

textMessagePreferred

boolean

Text messaging as preferred contact method

emailPreferred

boolean

Email as preferred contact method

contactTimeZone

string

Contact Time Zone. enums: EDT, CDT, MDT, MST, PDT, ADT, HST

contactAnyDay

string

Contact Any Day availability. enums: Anytime, Morning, Afternoon, Evening

contactMondays

string

Monday contact availability (Anytime/Morning/Afternoon/Evening)

contactTuesdays

string

Tuesday contact availability (Anytime/Morning/Afternoon/Evening)

contactWednesdays

string

Wednesday contact availability (Anytime/Morning/Afternoon/Evening)

contactThursdays

string

Thursday contact availability (Anytime/Morning/Afternoon/Evening)

contactFridays

string

Friday contact availability (Anytime/Morning/Afternoon/Evening)

contactSaturdays

string

Saturday contact availability (Anytime/Morning/Afternoon/Evening)

contactSundays

string

Sunday contact availability (Anytime/Morning/Afternoon/Evening)

notes

string

NBO file contact notes

eSignConsentWithdrawnBy

string

User ID of eConsent withdrawal initiator

eSignConsentRecipientId

string

eConsent recipient identifier (service-to-service only)

Headers

Authorization

string

required

Bearer token

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language

URL

Loading…

Response

Choose an example:

application/json

Usage Notes

❗️KNOWN ISSUE

200OK

❗️
KNOWN ISSUE