API v2 & Partner API v2
Data Ingress API v1
Getting Started
API Documentation
L3 Workbench API v1

Getting Started

Introduction

PrecisionLender is a cloud-based Pricing and Profitability Management System used by lending institutions, large and small, from across the nation. Several of our clients use the PrecisionLender Public API to automate and enhance their system integrations both upstream and downstream from pricing.

API Documentation

Along with articles to help you get started, this portal sets out to provide all of the necessary information you’d need to interact with our APIs. Our API documentation is generated using an OpenAPI Specification (formerly Swagger Specification) file, which we provide publicly as an aid for both code-generation and importing workspaces when using tools like Postman or Insomnia.

OpenAPI Specification

You can download the OpenAPI Specification file for any API by navigating to its top-level documentation.

Security & Authentication

PrecisionLender’s APIs are SSL-only, regardless of how your account is configured. You must also be a verified client, confirmed by the presence of a valid ClientId header.

Access to the APIs is governed primarily by Service Users, which can be retrieved or privisioned by logging into PrecisionLender.

Provisioning Service Users

For steps on how to retrieve or provision a Service User in PrecisionLender, refer to this article in the PrecisionLender Support Center.

PrecisionLender offers two methods of authentication:

Basic Authentication

Basic Authentication utilizes a Username:Password string, which is then base64-encoded to generate an Authorization header. The Username and Password in this case correspond with your Service User Name and Service User Key, respectively. The steps to use Basic Authentication are as follows:

  1. With your Service User Name and Service User Key, build a string in the format of ServiceUserName:ServiceUserKey.

  2. Base64 encode that string.

  3. Set the Authorization header to Basic, followed by the base64-encoded string.

    For example, if your base64-encoded string was GQCtbzpwQDU1dzByZA==, your Authorization header would look like the following:

    Authorization: Basic GQCtbzpwQDU1dzByZA==

oAuth 2.0

To use oAuth 2.0, call the Token endpoint with your Service User credentials. As with Basic Auth, the Username and Password correspond to your Service User Name and Service User Key, respectively.

The response will be the following:

{
  "access_token": (token),
  "expires_in": 3600,
  "token_type": "Bearer"
}

The value of the access_token property is then used as the Bearer token for additional API calls:

Authorization: Bearer (token)

Requests

PrecisionLender supports JSON exclusively in all requests. Additionally, requests are required to have a ClientId. This means that all requests made should include the following headers:

Content-Type: application/json
ClientId: (ClientID)

PrecisionLender uses the following convention for mapping request methods to the action they perform:

GET - Used to retrieve an existing record

POST - Used to create a new record

PATCH - Used to update an existing record

DELETE - Used to delete an existing record

PATCH

When using PATCH, you’re only required to define the values that you intend to change. For example, if you only wanted to change a user’s First Name, the following request is acceptable:

{
  "FirstName": "John"
}

All other properties of the user would remain unchanged.

Responses

As with requests, all responses will be in JSON format. For all endpoints, any 200 response means that the request was successful, whereas any 400 reponse means that the request failed.

Endpoint-specific responses, including both success and error codes, response format, and field examples, can be found by navigating to their respective documentation page.

DateTime Format

All date-time fields refer to UTC time, represented using the ISO 8601 format.

Additional Support

If you are looking for additional information about PrecisionLender that isn’t covered here, or if you’d like to reach out for assistance, we encourage you to visit our Support Center!