V3 Contracts

External User Contract Attributes

The following objects and attributes make up the ExternalUserContract object. The ExternalUserContract object contains information about each TPO user in the system.

ATTRIBUTE	DESCRIPTION
id string	Unique identifier of the external user.
useCompanyAddress boolean	Indicates whether the company address will be used for the user address.
firstName string	External user’s first name.
middleName string	External user’s middle name.
lastName string	External user’s lastname.
suffix string	Suffix for the external user.
title string	External user’s professional title.
address string	External user’s address.
city string	External user’s city.
state string	External user’s state.
zipCode string	External user’s zipcode.
phone string	External user’s phone number.
cellPhone string	External user’s cell phone number.
fax string	Fax number for the external user.
email string	Email address for the external user.
nmlsId string	The external user’s NMLS ID.
nmlsCurrent boolean	Indicates whether the external user’s NMLS is current.
ssn string	Social Security Number of the external user.
useParentInfoForRateLock boolean	Indicates whether the parent information is used for rate lock.
emailForRateSheet string	Email address to which the system will send the Rate Sheet.
faxForRateSheet string	Fax number to which the system will send the Rate Sheet.
emailForLockInfo string	Email address to which the system will send the Lock information.
faxForLockInfo string	Fax number to which the system will send the Lock information.
disabledLogin boolean	Indicates whether login is disabled for the user on TPO WebCenter websites.
emailForLogin string	Email address the user will use to log in to the TPO WebCenter websites.
passwordChangedDate string	The date on which the password was last changed. The format is yyyy-MM-ddTHH:mm:ssZ.
welcomeEmailSent string	Content of the Welcome Email sent the user.
welcomeEmailDate string	Date on which the Welcome Email was sent. The format is yyyy-MM-ddTHH:mm:ssZ.
siteUrls Array[string]	The TPO WebCenter site that the user will use to submit loans to your company.
approvalCurrentStatus string	The TPO user’s approval condition with your company.
addToWatchlist boolean	Indicates whether the TPO user is added to the Watchlist so that loans submitted by the user can be monitored.
approvalCurrentStatusDate string,	The date of approval. The format is yyyy-MM-dd.
approvalDate string	The date the user was approved by your company. The format is yyyy-MM-dd.
salesRep EntityReferenceContract	Sales rep assigned to the user.
personas Array[EntityReferenceContract]	Personas to which the user belongs.
roles Array[EntityReferenceContract]	Roles to which the user belongs.
groups Array[EntityReferenceContract]	Groups to which the user belongs.
peerLoanAccess string	Access level to peer loans. Possible values are: Disabled ReadOnly ReadWrite
accessMode string	Access mode. Possible values are: ReadWrite ReadOnly
licenses Array [ExternalUserStateLicenseContract]	The states in which the contact is licensed to originate loans.
roleTypes Array[string]	Role types assigned to the contact that define the user’s access rights to the TPO WebCenter site.
notes string	Additional information about the user.
requirePasswordChange boolean	Indicates whether the user is required to change the password after initial log in.
lastLogin string	The date and time the user logged in last. The format is yyyy-MM-ddTHH:mm:ssZ. Retrieve only.
updatedBy EntityReferenceContract	The user who last updated the TPO user’s information. Retrieve only.
updatedDateTime string	The date and time the user information was updated. The format is yyyy-MM-ddTHH:mm:ssZ. Retrieve only.
organization EntityReferenceContract	TPO organization to which the user belongs.

External User State License Contract

The following objects and attributes make up the ExternalUserStateLicenseContract object. The ExternalUserStateLicenseContract object contains state license information for a TPO.

Where to find these field attributes in Encompass:
These attributes are located on the Encompass > Settings > External Company Setup > License tab.

ATTRIBUTE	DESCRIPTION
stateAbbrevation string	Two letter abbreviation for the state. [Required] ['AL', 'AK', 'AZ', 'AR', 'CA', 'CO', 'CT', 'DC', 'DE', 'FL', 'GA', 'HI', 'ID', 'IL', 'IN', 'IA', 'KS', 'KY', 'LA', 'ME', 'MD', 'MA', 'MI', 'MN', 'MS', 'MO', 'MT', 'NE', 'NV', 'NH', 'NJ', 'NM', 'NY', 'NC', 'ND', 'OH', 'OK', 'OR', 'PA', 'RI', 'SC', 'SD', 'TN', 'TX', 'UT', 'VT', 'VA', 'WA', 'WV', 'WI', 'WY', 'VI', 'GU', 'PR']
selected boolean	Indicates whether the state license is selected for the TPO.
licenseNumber string	The license number.
issueDate string	Date the license was issued. The format is yyyy-MM-dd.
startDate string	Date the loan officer’s license becomes associated with the company and can start taking loan applications on behalf of the company. In most states this is referred to as the Sponsorship Date (not required in all states). The format is yyyy-MM-dd.
endDate string	Date the license expires. The format is yyyy-MM-dd.
licenseStatus string	The status of the license. Some examples are Approved or Pending. [RetrieveOnly]
licenseStatusType string	The type of the license status. ['TransitionRequested', 'TransitionCancelled', 'TransitionRejected', 'PendingIncomplete', 'PendingReview', 'PendingDeficient', 'PendingWithdrawRequested', 'WithdrawnApplicationAbandoned', 'WithdrawnVoluntaryWithoutLicensure', 'Denied', 'DeniedOnAppeal', 'Approved', 'ApprovedConditional', 'ApprovedDeficient', 'ApprovedFailedToRenew', 'ApprovedInactive', 'ApprovedOnAppeal', 'ApprovedSurrenderOrCancellationRequested', 'Revoked', 'RevokedOnAppeal', 'Suspended', 'SuspendedOnAppeal', 'TemporaryCeaseAndDesist', 'TemporaryExpired', 'TemporaryFailedtoRenew', 'TerminatedOrderedToSurrender', 'TerminatedSurrenderedOrCancelled']
statusDate string	Date the status is in effect. The format is yyyy-MM-dd.
lastChecked string	Date the status was last reviewed. The format is yyyy-MM-dd.