V3 Manage Vesting Entities

patch

https://api.elliemae.com/encompass/v3/loans/{loanId}/closingDocument/vestingEntities?view=entity

This API manages vesting entities configured in Encompass on the Vesting Information page and NBO records from the File Contacts page.

You can perform one of these operations in a single transaction on all the entries in this collection:

add - Add a borrower vesting entity.
delete - Remove a borrower vesting entity from the application.
reorder - Swap the order of existing borrower vesting entities in the application.
replace - Replace a borrower vesting entity.
update - Update existing borrower vesting entities in the application.

Usage Note

With this initial release, non-borrowing owners cannot be added to vesting entities using the Borrower Vesting APIs. To add a non-borrowing owner to a vesting entity, use the Create Loan API or the Encompass Smart Client.

Path Params

loanId

string

required

Unique identifier of the loan. Required.

Query Params

action

string

Action to be performed on the vesting entity. Possible values are add, delete, reorder, replace, and update.

Body Params

string

ReadOnly. Unique identifier of the vesting entity. For example, 272109a1-9ed6-4d1f-8861-f1177952de57

alias

string

A name that the borrower has also used. Use a semicolon to separate additional names.

application

object

Information about the borrower pair.

poaSignatureText

string

The title of the individual who will serve as the power of attorney, if applicable. If not provided, and the Encompass Docs Service is used, the generated documents will reflect the correct state-specific language (for example, Attorney-in-fact).

occupancyIntent

string

The borrower's occupancy intent. Possible values are:
Will Occupy

Will Not Occupy

Currently Occupy

Null

occupancyStatus

string

The property use type. Possible values are:
PrimaryResidence

SecondHome

*Investment

powerOfAttorney

string

The name of the individual who will serve as the power of attorney, if applicable.

ssn

string

The borrower's social security number.

birthDate

string

The borrower's date of birth. The format is yyyy-mm-dd.

unparsedName

string

Required. Not Required field for Update action.
The borrower’s name.

vesting

string

Describes the ownership rights of the borrower. For example, A Married Man, A Married Woman, Domestic Partners, An Individual Adult, etc.

vestingGuid

string

ReadOnly. The unique identifier of the vesting entity.

vestingTrusteeOfType

string

Type of trustee. Possible values are:
Trust 1

Trust 2

*Null

authorizedToSignIndicator

boolean

Indicates whether the user is authorized to sign closing documents.

vestingType

string

Required. Not Required field for Update action. Describes the borrower's financial responsibility related to the loan. The Vesting Type affects the documents included in the document set. Possible values are:

Individual

Co-signer

Title only

Non Title Spouse

Trustee

Title Only Trustee

Settlor Trustee

Settlor

Title Only Settlor Trustee

Officer

nonBorrowingOwner

object

ReadOnly. For NonBorrowingOwner, vestingTypes allowed are:

TitleOnly = 2

NonTitleSpouse = 3

TitleOnlyTrustee = 5

TitleOnlySettlorTrustee = 8

Note: With this initial release, non-borrowing owners cannot be added to vesting entities with the Borrower Vesting APIs. Use the Create Loan API or the Encompass Smartclient to add a non-borrowing owner to a vesting entity.

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

200OK