V3 Manage Vesting Entities

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 to add a borrower vesting entity
  • delete to delete a borrower vesting entity from the application
  • reorder to swap the order of existing borrower vesting entities in the application
  • replace to replace a borrower vesting entity
  • update to update existing borrower vesting entities in the application

Usage Notes

  • 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
string
required

Unique identifier of the loan.

Query Params
string

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

Headers
string
required

Bearer token

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json