Roles Contract
The following attributes are contained within the RolesContract object. These attributes are created and managed in Encompass > Settings > Company/User Setup > Roles.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| roles Array[EntityReferenceContract] | Details about the user's role eligibility. |
| EntityReferenceContract | List of eligible roles. Refer to attributes listed in the Entity Reference contract table. |
| entityId string | Required. User ID of the specified user. To get the eligible roles for the logged-in user, use the alias me. |
| entityName string | RetrieveOnly. Name of the role. A few examples are Loan Officer, Loan Processor, Lock Desk, and Underwriter. |
| entityType string | Role. |
User Contract
The following attributes are contained within the UserContract object.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| id string | Required. Unique Identifier of the user. The ID the user will type when logging in. The ID can’t start with a period (.). The following characters can’t be used: \ (backslash) / (forward slash) : (colon) * (asterisk) ? (question mark) “ (quotation mark) < (less than) > (greater than). Max length: 16. |
| firstName string | Required. First name of the user. Max length: 64. |
| middleName string | Middle name of the user. Max length: 64. |
| lastName string | Required. Last name of the user. Max length: 64. |
| suffix string | Suffix of the user. Max length: 64. |
| fullName string | RetrieveOnly. Full name of user. |
| loginEnabled boolean | Indicates whether the user account is locked out due to failed log-in attempt. Automatically set to true a user exceeds the allowed failed log-in attempts (as specified in the Password Management tool). Set to false to remove the restriction and allow the user to log in again. If not provided when creating a user, default value is 'true'. |
| accountEnabled boolean | Indicates whether the user account is deactivated. Set to true when you want to deactivate a user account and prohibit them from accessing Encompass. Set to false to reactivate the user account and allow them to access Encompass again. If not provided when creating a user, default value is 'true'. |
| password string | User’s login password. The password must meet the requirements established in the Password Management tool. Password must follow the password guidelines configured in Server Settings Manager. Password is optional for SSO user and API user. Max length: 50. |
| jobTitle string | Job title of the user. Max length: 64. |
| email string | Required. Email address of the user. Max length: 64. Format: ######@###.### |
| phone string | Phone number of the user. Format: ###-###-#### #### |
| cellPhone string | Cell phone number of the user. Format: ###-###-#### #### |
| fax string | Fax number of the user. Format: ###-###-#### #### |
| employeeId string | Employee ID of the user for the organization. |
| chumId string | Number assigned to the user for use with the HUD Computerized Homes Underwriting Management System (CHUMS). |
| nmlsOriginatorId string | Enter user's Nationwide Mortgage Licensing System (NMLS) Loan Originator ID (NMLS number). If the user is a loan officer, this number is added to Page 3 of the 1003 application when they are assigned to the loan. |
| nmlsExpirationDate date-time | The expiration date for the user’s Nationwide Mortgage Licensing System (NMLS) Loan Originator ID (NMLS number). When the NMLS number expires, loan team members will not be able to assign loans in that state to the user. If a loan has already been assigned to the user and their NMLS number subsequently expires (or if the user tries to originate a new loan after the expiration date) they will not be able to enter the Subject Property State in the loan file. If the NMLS Expiration Date is left blank, Encompass assumes the NMLS number never expires. Format: [Date: yyyy-MM-dd] |
| workingFolder string | Loan Folder that opens the first time the user accesses the Pipeline. Only one can be selected. From an API perspective, it will be stored in string property but folder name validation has to be done. |
| apiUser boolean | Indicate if the user is an API user. The purpose of the API User check box is to provide Encompass administrators the ability to grant a consulting Encompass Partner with access to your company's Encompass instance and access to your company's APIs stored in Encompass Developer Connect. Only appears when creating new users. Does count against your company's enabled user license limits. This check box is intended for use with Supported Encompass Partners only and should not be used for users within your organization. Once the Partner and the Encompass administrator complete the required process, the Partner will be recognized as a Supported Encompass Partner and they will be able to access your company's Encompass instance via APIs. The administrator will be able to assign the required privileges to this API user just as they would for any other Encompass user. However, this API user will not be able to log into any Encompass instances via Encompass. |
| isSsoOnly boolean | This is used to enable SSO login. 'isSsoOnly' attribute can be provided only if 'password' attribute is not provided. Default value is false. This attribute indicates when the user’s Login Access level is linked to their Organization. When attribute is true, the user must log into Encompass using Single Sign-On credentials with their company's identity service provider (IdP) only. They will not be permitted to log in using their Encompass user name and password credentials. When this attribute is false, the user’s login access level is “Full Access” and users can log into Encompass using their Encompass user name and password credentials OR Single Sign-On credentials with their company's IdP. Refer to the Setting Up SSO in Encompass guide for complete details about setting up SSO and this attribute. Values are 'true' or 'false'. This is enabled in Encompass based on Company settings Category : PASSWORD. Attribute :SSOLOGIN. |
| ssoDisconnectedFromOrg boolean | Indicates if the SSO user is connected to the org or disconnected from the org. Values are 'true' or 'false'. |
| allowImpersonation boolean | To enable other Encompass Partners or other individuals to access your company's APIs by using this user account to call the APIs. Values are 'true' or 'false'. AllowImpersonation can only be set when apiUser is 'true'. |
| requirePasswordChange boolean | This forces user to change the password on first login. Values are 'true' or 'false'. Default value is 'false'. |
| personas array | The persona controls the views and features available to the user. |
| groups array | List of user groups that the user is associated with. |
| licenses array | States in which the user is licensed to originate loans. The user can start a loan only if the subject property is in a state in which the user is licensed. When a state license expires, loan team members will not be able to assign loans in that state to the loan officer. If the Expiration Date field is left blank, Encompass assumes the license never expires. Refer to attributes listed in the User State License contract table. |
| compensationPlans object | Collection of attributes related to the user’s assigned current, future, and/or historical compensation plans. Refer to attributes listed in the Assigned Compensation Plans contract table. |
| organization object | The organization the user is a member of. |
| orgHierarchy array | RetrieveOnly. The location of the user within the organization hierarchy. Refer to attributes listed in the Organization Hierarchy Entity Reference contract table. |
| createdDate date-time | The DateTime that the user was created. Format: [DateTime: yyyy-MM-ddTHH:mm:ssZ] |
| createdBy object | The entity and id that created the user. |
| lastModifiedDate date-time | RetrieveOnly. The most recent DateTime that the user was updated. Format: [DateTime: yyyy-MM-ddTHH:mm:ssZ] |
| lastModifiedBy object | The entity and id that last updated the user. |
| lastLogin date-time | Date and time when the user last logged in. Format: [DateTime: yyyy-MM-ddTHH:mm:ssZ] |
| oAuthClientId string | oAuthClientId is required when API user flag is true. Max length :100. |
| subordinateLoanAccess string | Access level to other uers's loans, when the user is in a lower level of the organization hierarchy as this user. Enumerations: ReadOnly, ReadWrite |
| peerLoanAccess string | Access level to other uers's loans, when the user is in the same level of the organization hierarchy as this user. Enumerations: Disabled, ReadOnly, ReadWrite |
| userIndicators array | RetrieveOnly. This field value will indicate if the user is one of the following enumerations: - TopLevelUser - TopLevelAdministrator - Administrator - SuperAdministrator |
| ccSite object | Array with ccSite information. |
| comments string | Free-form comments. |
| emailSignature string | The e-mail signature of the user. |
Entity Reference Contract
The following attributes are contained within the EntityReferenceContract object.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| entityId string | Required. The unique identifier of the particular entity. |
| entityName string | RetrieveOnly. The name of the particular entity. |
| entityUri string | RetrieveOnly. The Uniform Resource Identifier (URI) for the entity. |
| entityType string | The entity type. Enumerations: Default, User, Role, Condition, Application, Attachment, Document, MilestoneSetting, ReoProperty, NonBorrowingOwner, Milestone, BorrowerContact, BusinessContact, Organization, Persona, Form, FieldDefinition, ExternalOrg, PipelineView, PersonaView, UserView, LoanTemplateSet, TemplateFolder, ClosingCostTemplate, LoanFolder, LoanDuplicationTemplate, Loan, Borrower, CoBorrower, ResourceLock, CorrespondentMaster, CorrespondentTrade, LoanTrade, MBSPool, Trade, UserGroup, DocumentTemplate, ConditionView, DocumentView, Company, CompanyExtension, Branch, BranchExtension, Vod, Voe, Vol, Vom, Vor, CustomPlanCode, EMPlanCode, StandardForm, CustomForm, ConditionType, ConditionTemplate, LoanProgramTemplate, DisclosureTracking2015Log, SettlementServiceProviderTemplate, AffiliatedBusinessArrangements, RateLock, DesignatedRole, ExternalOrgPricingGroups, ExternalOrgCompanyStatus, ExternalOrgCompanyRating, LoanOriginatorCompensationPlan, ExternalUser, TemplateFile, DocumentSetTemplate, MilestoneTask, WorkflowTask, DocumentGroup, StackingOrder, Bank, Comment |
Organization Hierarchy Entity Reference Contract
The following attributes are contained within the OrgHierarchyEntityReferenceContract object.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| entityId string | Required. The unique identifier of the entity. |
| entityName string | RetrieveOnly. The name of the entity. |
| entityUri string | RetrieveOnly. The Uniform Resource Identifier (URI) for the entity. |
| entityType string | The entity type. Enumerations: Default, User, Role, Condition, Application, Attachment, Document, MilestoneSetting, ReoProperty, NonBorrowingOwner, Milestone, BorrowerContact, BusinessContact, Organization, Persona, Form, FieldDefinition, ExternalOrg, PipelineView, PersonaView, UserView, LoanTemplateSet, TemplateFolder, ClosingCostTemplate, LoanFolder, LoanDuplicationTemplate, Loan, Borrower, CoBorrower, ResourceLock, CorrespondentMaster, CorrespondentTrade, LoanTrade, MBSPool, Trade, UserGroup, DocumentTemplate, ConditionView, DocumentView, Company, CompanyExtension, Branch, BranchExtension, Vod, Voe, Vol, Vom, Vor, CustomPlanCode, EMPlanCode, StandardForm, CustomForm, ConditionType, ConditionTemplate, LoanProgramTemplate, DisclosureTracking2015Log, SettlementServiceProviderTemplate, AffiliatedBusinessArrangements, RateLock, DesignatedRole, ExternalOrgPricingGroups, ExternalOrgCompanyStatus, ExternalOrgCompanyRating, LoanOriginatorCompensationPlan, ExternalUser, TemplateFile, DocumentSetTemplate, MilestoneTask, WorkflowTask, DocumentGroup, StackingOrder, Bank, Comment |
| parentId string | Entity id of the parent. |
User State License Contract
The following attributes are contained within the UserStateLicenseContract object.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| stateAbbreviation string | Required. The two character abbreviated format of the state. Enumerations: 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 | To specify the states in which the license is applicable. A value of 'true' indicates a license is applicable for the specified state. |
| licenseNumber string | License number. |
| issueDate date-time | The date the license is issued to the loan officer. Format: [DateTime: yyyy-MM-dd] |
| startDate date-time | The date that the loan officer’s license becomes associated with the company and they 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). Note that even if a loan officer has been issued a valid license, in many cases they can’t legally represent a new company until their license sponsorship transfers to their new employer. Format: [DateTime: yyyy-MM-dd] |
| endDate date-time | To specify an expiration date, type the expiration date. When a state license expires, loan team members will not be able to assign loans in that state to the loan officer. If a loan has already been assigned to the loan officer and their license subsequently expires (or if the loan officer tries to originate a new loan after their license expires), they will not be able to enter the Subject Property State in the loan file. If the End Date field is left blank, Encompass assumes the license never expires. Format: [DateTime: yyyy-MM-dd] |
| licenseStatus string | RetrieveOnly. Status of the license. |
| licenseStatusType string | To enter the license status, select the valid value of the list. Enumerations: 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 date-time | To specify the Status Date (date that the status is in effect) and the Last Checked date (date that the status was last reviewed), type the status and/or last checked date. Format: [DateTime: yyyy-MM-dd] |
| lastChecked date-time | Last checked date for the license. Format: [DateTime: yyyy-MM-dd] |
User Profile Contract
The following attributes are contained within the UserProfileContract object.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| enabled boolean | Indicates if the user profile is activated or deactived. |
| fullName string | RetrieveOnly. Full name of user. |
| firstName string | First name of the user. Max length: 64. |
| lastName string | Last name of the user. Max length: 64. |
| middleName string | Middle name of the user. Max length: 64. |
| suffix string | Suffix of the user. Max length: 64. |
| jobTitle string | Job title of the user. Max length: 64. |
| phone1 string | Phone number one of the user. Format: ###-###-#### #### |
| phone2 string | Phone number two of the user. Format: ###-###-#### #### |
| nmlsOriginatorId string | Enter user's Nationwide Mortgage Licensing System (NMLS) Loan Originator ID (NMLS number). If the user is a loan officer, this number is added to Page 3 of the 1003 application when they are assigned to the loan. |
| link1 string | The first URL link for the user profile. Format: #####://###.######.### Max length: 64. |
| link2 string | The second URL link for the user profile. Format: #####://###.######.### Max length: 64. |
| link3 string | The third URL link for the user profile. Format: #####://###.######.### Max length: 64. |
| description string | The description for the user's profile. Max length: 1000. |
Lockable String Field Contract
The following attributes are contained within the LockableStringFieldContract object.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| useUserValue boolean | Required. Use to indicate if using userValue to override computedValue. Use 'true' to override. |
| userValue string | User value field to use when overriding computedValue. |
| computedValue string | RetrieveOnly. Pulled from main user profile. |
Phone Number Contract
The following attributes are contained within the PhoneNumberContract object.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| type string | Type of phone number. Valid values: Work, Cell, Fax |
| phoneNumber string | Phone number. Format: ###-###-#### #### |
Assigned Compensation Plans Contract
The following attributes are contained within the AssignedCompPlansContract object.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| useParentInformation boolean | When use parentInfo is set as true, to apply the compensation plans from the parent company. While you can assign a compensation plan to an individual loan officer, you can also assign a compensation plan to a company or branch. With a company or branch compensation plan in place, you can then select the Use Parent Info check box to assign the company or branch plan to a loan officer. Any plans that are assigned to the company or branch in the future will then be applied to the loan officer. If this compensation plans object is passed then this property is mandatory. |
| futurePlans array | Future plans array. |
| currentPlan array | RetrieveOnly. Current plans array. |
| historicalPlans array | RetrieveOnly. Historical plans array. |
Assigned Compensation Plan Contract
The following attributes are contained within the AssignedCompPlanContract object.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| plan See Ref Contract | The compensation plan. |
| startDate date-time | Required. Start date of the plan. Format: [DateTime: yyyy-MM-dd] |
| endDate date-time | RetrieveOnly. The end date of the plan. Format: [DateTime: yyyy-MM-dd] |
Consumer Connect Information Contract
The following attributes are contained within the CCSiteInfoContract object.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| useParentInformation boolean | Use parent information to inherit the site URL. |
| siteId string | Encompass Consumer Connect Site ID. Note: For Creating and Updating a user with Consumer Connect site details you must pass Consumer Connect siteId in the request payload. |
| url string | Encompass Consumer Connect Site URL. |
© ICE Mortgage Technology, Inc. All rights reserved.