Loan Recipients Contracts and Attributes
The following section lists each contract used in the Loan Recipients API and describes all the attributes that make up each contract. All attributes are optional unless otherwise specified.
Loan Recipients Response Contract
The following objects and attributes make up the Loan Recipients Response Contract.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| id string | eDelivery Recipient identifier. |
| name string | Full name of the recipient. |
| email string | Email address of the recipient. |
| contactType string | Type of contact. For example: Borrower CoBorrower NonBorrowingOwner (or NBO) File Contact |
| loanAccessToken string | The universally unique token that is appended to the URL link in the notification email. |
| authenticationType string | Type of authentication that will be used. Possible values are SMS and AuthCode |
| authenticationCode string | Code that the recipient will have to enter to authenticate themselves (only applies when authenticationType = AuthCode ). |
| isAuthenticated boolean | Indicates whether the recipient has been authenticated. |
| uuid string | Identifies the Portal User Account. |
| enabled boolean | Indicates whether the recipient's account is enabled. |
© ICE Mortgage Technology, Inc. All rights reserved.