Toll Free 1-877-506-2744
How can we help?

Service User Account Access for PrecisionLender API

Print Friendly Version of this pagePrint Get a PDF version of this webpagePDF

Related Articles

Overview

In order to use the PrecisionLender API at least one Service User account will need to be setup and enabled.  Service User accounts add an additional layer of security and provide a more reliable audit trail.

 

Requirements

  • PrecisionLender user with Manage Users and Manage Access rights
  • Service User API access enabled by PrecisionLender

Getting Started

There are two steps involved to setup and manage Service User Accounts:

 

Step 1: Enable a PrecisionLender user to setup the Service Accounts

In the Administration section a user with Manage Access rights will need to add the Manage API Access right to a new or existing Security Profile for users that can create and manage Service User Accounts. 

 

Shows the new

  

Step 2: Set up and Management of the Service User Account

In the Administration screen on the 'Integrations' section, a user with the Manage API Access right can setup or manage a new Service User account. To add a new Service User account, select 'New' next to Service Users. To edit an existing Service User, select the name from the list.

 

Add_Partner.PNG

 

Add New

Administration-ServiceUserSetup.PNG

Service User Account Fields

  • Name
    • Name required for all API calls
  • Key
    • Key required for all API calls
    • Unique to each Service User account
  • Client ID
    • Required for all API calls
    • PrecisionLender assigned identifier for your bank
  • Enabled
    • Service User can be disabled by unchecking this box
    • Service Users cannot be deleted, only disabled
  • Service User Roles Assignment 
    • Service Users can have multiple roles (Ex. Admin, User Management or Reporting)
    • Note: It is recommended to create separate Service Users for critical use cases such as Data Ingress, CRM Integration or LOS Integration roles to prevent confusion or downtime if keys get removed or regenerated. 

 

Add Partner

In some cases, you may partner with other vendors (such as swap rates providers) and need to provide them with your API credentials. Adding the partner as a Partner Service User will provide them with limited and un-editable access sufficient for their upload needs. This is available via package setting and must be turned on for you by PrecisionLender. Please contact support@precisionlender.com if you'd like to enable this feature.

 

Add_Partner_Fields.PNG

 

Partner Service User Account Fields

  • Name
    • Name required for all API calls
  • Key
    • Key required for all API calls
    • Unique to each Service User account
  • Client ID
    • Required for all API calls
    • PrecisionLender assigned identifier for your bank
  • Enabled
    • Service User can be disabled by unchecking this box
    • Service Users cannot be deleted, only disabled

 

Security Audit

To view a report of why a Service User call failed, select the 'Security Audit' button from the Service Users section of the 'Regions and Users' section of the Administration screen.

Service_User_Security_Audit.PNG

  • A new window will appear with the following information:
    • Timestamp of the failure
    • The username of the Service User that failed
    • The failure reason, including
      • Invalid Username
      • Invalid IP address
      • Not provisioned for API access
      • Invalid Category
      • Invalid Key

Webhooks 

Please visit our Developer Portal to see more information on webhooks.

Next Steps

If you would like to use the PrecisionLender API, please contact us by submitting a support request with "API Access Request" as the subject line. From there the PrecisionLender Integrations team will be in touch to enable access and help you get started.

 

Was this article helpful?
Have more questions?