This API provides a set of methods to access and update borrower information in the Encompass contacts database. Borrower information includes the personal information of past, present, and potential borrowers.

Use the Get Canonical Names API to retrieve a list of canonical field names that can be used to view, sort, and filter borrower contact information. The Borrower Field Definition Attributes are described below.


About Personal and Public Borrower Contacts

  • Borrower contacts can be personal or public.
  • With public resources, only users whose profiles allow access to Templates and Tables can create or edit public contacts.
  • The accessLevel parameter defines whether the contact is personal or public.
  • Public borrower contacts are available for viewing only by users above the contact owner in the organization hierarchy.
  • To create and update personal borrower contacts, users must have the Create Contacts option enabled in Encompass persona settings.