Download Postman Collection
API Reference

V1 Contracts

Persona ACL Contract Attributes

ATTRIBUTEDESCRIPTION
id
string		Persona ID
name
string		Name of the persona.
defaultAccess
string		Whether the persona has access granted to all Encompass features or access to no features. Possible values are All and None.
isInternal
boolean		Whether the persona is an Internal persona
isExternal
boolean		Whether the persona is an external persona. A persona can be internal and/ or external.
displayOrder
integer		The order in which the persona is to be displayed.
aclRights
UserAclRightsContract 		Access Rights associated with the persona. All the rights that are enabled for the persona are returned as part of this object.

The Access Rights (aclRights) contract comprises of all the categories that a persona can have permissions for. They have been classified into some major and minor categories. By querying on any number of these categories, you can retrieve all the relevant categories that you want to determine the persona's permissions for.

The major categories are :

  • Contacts
  • Pipeline
  • EFolder
  • Settings
  • Tools
  • Loan
  • TpoConnect
  • ExternalSettings
  • Forms
  • Access
  • Home

The minor categories are :

  • MoveLoans
  • Services
  • ImportLoans
  • DuplicateLoans
  • ManageServiceProviders
  • MilestoneWorkflowManagement
  • PipelineServices
  • AdditionalServices
  • AusTracking
  • BorrowerContacts
  • BusinessContacts
  • BusinessRules
  • ClosingDocs
  • CompanyUserSetup
  • ConditionsHistory
  • ConsumerConnect
  • ContactSetup
  • Dashboard
  • DisclosureTracking
  • DocsSetup
  • Documents (contains UnprotectedDocuments, UnassignedFiles, and ProtectedDocuments)
  • DynamicDataManagement
  • EDisclosures
  • EFolderSetup
  • FileContacts (comes under Loan category, not Contacts category. Contains GrantWriteAccess for ability to grant write access to team members)
  • GseServices
  • ItemizationFee
  • LoanSetup
  • PersonalSettings
  • PersonalTemplates
  • PostClosingConditions
  • PreliminaryConditions
  • Print
  • PurchaseConditions (newly added, may not yet be in SmartClient UI)
  • Reports
  • SecondarySetup
  • SmartClient (may be deprecated – features specific to SmartClient)
  • SystemAdministration
  • TablesAndFees
  • TpoCompanyDetails
  • TpoConnectSiteManagement
  • TpoContacts
  • TpoFees
  • TpoInformation
  • TpoOrganizationSettings
  • TqlServices
  • Trades
  • UnderwritingConditions
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use