Knowledge Base

The FFIEC Lookup – API Tool enables users to seamlessly pull census data directly into a loan file in Encompass® with a single click. Instead of manually searching for property data, this tool uses an API to automatically download over 30 data points, including income, population, and housing details, into the loan.

• Saves time
  
• Improves accuracy
  
• Automatically adds a report to the eFolder
  
• Can be triggered manually or automated with business rules
  

To turn this tool on:

1. Log in to Encompass® as a Super Admin.

2. Open LTK PowerTools™ from the Encompass® menu. Confirm the license includes the Expert, Optimized or Enterprise Tier.

3. Click Settings > PowerTools™ Expert tab.

4. Turn on the FFIEC Lookup – API by clicking On.

Important: After activation of the Tool, be sure to wait for the prompt stating that the download is complete prior to continuing.

5. Ensure a license number populated and restart Encompass®.

Important: Turning the tool on will install the input form.  However, the lookups will not function until the API Client ID is created and an API user is added to the Encompass® instance.

Important Note:

This requirement is expected to be removed in a future Encompass® API update.

Automated Search

Admins can automate searches using a custom trigger field rule. By default, the custom field to trigger the automation is [CX.FFIEC.TRIGGER.API]. When the field is set to “X”, the tool automatically runs the search for census data. Super Admins can change this to a different custom field if desired.

Manual Search

1. Open the LTK – FFIEC Lookup – API input form.
2. Click Submit. This will request or update census data for the subject property.
   
3. After submitting, exit the loan and wait about 5 minutes to allow the API to update the loan file.
   

To view the data returned from FFIEC, go to the LTK – FFIEC Lookup – API input form. The data is organized into four (4) tabs:

• Census Data
  

• Income Data
  

• Population Data
  

• Housing Data
  

Each field is mapped to a standard or custom Encompass® field, which can be used in reports, pipeline views, or business rules.

On the LTK – FFIEC Lookup – API form, click the Gear icon (visible only to Super Admins) to open the settings.

1. eFolder Destination - Each search adds a PDF of the results to this placeholder in the eFolder.  If the eFolder document has not yet been created, the tool will create it in the loan and add the PDF to it. 
   
2. Automation Field - The default field is CX.FFIEC.TRIGGER.API.  Setting this field to “X” launches the API automation.
   
3. Auto Add FFIEC Receipt to eFolder – When checked, the resulting PDF file will be added to the eFolder.  Uncheck this box to prevent the automatic addition.
   
4. Default Census Year – This is set by the Super Admin to identify which year the census data should pull from.  This can be updated when new Census data has been published.
   
5. Click Save to commit any changes made.
   

Please note that the API versions of our PowerTools™ require an API user to be created in each instance where the PowerTools™ are installed. Lender Toolkit can submit a request to ICE to generate the Client ID and secret key pair.  If credentials have not been obtained, use the link below to request credentials.

Request API Credentials for PowerTools and Automations

• Custom Form: LTK – FFIEC Lookup – API
  
• Codebase Assemblies: None
  
• Custom Data Objects: None
  
• Plugins: LTK.Plugin.Portal.dll
  

The link below contains a list of custom fields that are used in the FFIEC Tool.

FFIEC Field Definitions.xlsx