API Integration Guide for the PLL Platform

API Summary

API Setup and input form creation

Getting a Loan Template

API Details

Authentication

Document

Comment

Notifications

Response and Status Codes

Document Status Codes

API Response Codes

Getting Started

PLL API Documentation

v1.1

Production

Sandbox

<p class="slate-p " >The API Integration Guide for the PLL Platform offers a comprehensive overview of the PLL API, aimed at facilitating seamless interactions between client systems and the PLL platform. Users can leverage this guide to streamline the management of loan document submissions and related processes, accessing an efficient and user-friendly interface for integration purposes.</p><p class="slate-p " ><strong class="slate-bold">Key Features and Operations </strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Submit Requests</strong></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Initiate and submit loan document requests with all necessary information.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Retrieve Request Status</strong></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Easily monitor the progress of submitted requests through status checks.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Resubmit Requests</strong></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Resubmit requests with updated information when corrections are required.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Manage Comments</strong></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Post new comments and access existing ones linked to specific requests, improving communication and documentation.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Real-Time Notifications</strong></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Stay updated with real-time changes and updates through <strong class="slate-bold">Server-Sent Events (SSE)</strong>, ensuring prompt client system notifications for any alterations.</div></li></ul></li></ul><p class="slate-p " ><strong class="slate-bold">Guide Overview </strong></p><p class="slate-p " >This guide covers: </p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">API Setup</strong>: Details on what is reqquired to setup the API in a development environment.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">API Endpoints</strong>: Details on available endpoints for various operations.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Request/Response Formats</strong>: Comprehensive examples and explanations for smooth integration.</div></li></ul><p class="slate-p " ></p><p class="slate-p " >While the API’s core functionality is stable, ongoing improvements may lead to minor changes (10-20%) to enhance performance and user experience. </p><p class="slate-p " >This introduction sets the foundation for understanding the purpose and capabilities of the PLL API, ensuring users have a clear context before diving into integration details. </p><p class="slate-p " ></p>

The API Integration Guide for the PLL Platform offers a comprehensive overview of the PLL API, aimed at facilitating seamless interactions between client systems and the PLL platform. Users can leverage this guide to streamline the management of loan document submissions and related processes, accessing an efficient and user-friendly interface for integration purposes.

While the API’s core functionality is stable, ongoing improvements may lead to minor changes (10-20%) to enhance performance and user experience. 

This introduction sets the foundation for understanding the purpose and capabilities of the PLL API, ensuring users have a clear context before diving into integration details. 

: This is a JSON structure that shows all of the required parameters that are needed to create a successful document.

: This is the document that is created by the application when all the input values are combined with the loan template. The document can be genrated as a PDF. 

: This is a  Private Lender Law employee involved in processing a loan. They will manualy review loan documents and 

may request additional information as required.

: this is the status that the loan has which is updated as the loan in processed through the loan doocument lifecycle. Statuses include 

initiated, temp, moreInfo, submitted, accepted, rejected, and completed

<p class="slate-p " >The API Setup and Input Form creation section guides users on setting up authentication parameters to securely access the Loan Document application. By obtaining a unique clientId and clientSecret provided by Private Lender Law, users can generate a token for authenticating API calls. This section is essential for establishing a secure connection initiating API interactions, and correctly creating and updating loan documents within the application.</p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " >The base URL for the sandbox and the production environment is <em class="slate-italic">currently</em> identical. The authentication parametrs fo rthe API determine whihc environment is accessed.</p></div></div><p class="slate-p " ><h3 class="slate-h3 " ><strong class="slate-bold">Authentication Parameters</strong></h3><p class="slate-p " >Private Lender Law (PLL) will create a unique instance of the Loan Document application. Once this is created PLL will provide a unqiue <code class="slate-code">clientId</code> and <code class="slate-code">clientSecret</code>. This can then be used to create a <code class="slate-code">token</code> that is used in the authentication of each API call. </p><p class="slate-p " ></p><h3 class="slate-h3 " >White Listed IP addresses</h3><p class="slate-p " >The API is current <strong class="slate-bold">not</strong> restricted to a whitelist IP range.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Loan Templates</h3><p class="slate-p slate-indent-0" style="0px">To test and utilize the PLL API, you must create forms capable of submitting parameters in the correct JSON structure. The PLL system provides loan templates tailored to specific loan types (categories) and locations (states). These templates are formatted as Microsoft Word documents containing merge fields, which are then populated with input form data to generate completed loan documents. The finalized documents can be exported as PDF files.</p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " >The loan templates in the sandbox and the loan templates in the production enviroment are NOT shared at this time. Therefore, if a loan template is updated for production, then the sandbox version must be updated by a PLL user to be tested in the sandbox environment</p></div></div><p class="slate-p slate-indent-0-1-1" style="NaNpx"></p><p class="slate-p slate-indent-0-1-1-1-1-1-1-1" style="NaNpx"></p><h3 class="slate-h3 " >Input Forms</h3><p class="slate-p slate-indent-0" style="0px">Inpit forms can be created that confirm to producing the correct JSON Object to be processed by the API. The example requests and responses show typical code blocks for the most common environments.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Example JSON Object for a Loan Template</h3><p class="slate-p " >Below is an example of the JSON object structure used in the API to define loan template parameters:</p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
  &quot;lenderName&quot;: &quot;HSBC&quot;,
  &quot;category&quot;: &quot;Personal Loan&quot;,
  &quot;state&quot;: &quot;New York&quot;,
  &quot;variables&quot;: {
    &quot;inputVariables&quot;: [
      {
        &quot;variableKey&quot;: &quot;loanPurpose&quot;,
        &quot;variableValue&quot;: &quot;string&quot;
      }
    ],
    &quot;borrowerDetails&quot;: {
      &quot;borrowers&quot;: [
        {
          &quot;variables&quot;: [
            {
              &quot;variableKey&quot;: &quot;borrowerName&quot;,
              &quot;variableValue&quot;: &quot;string&quot;
            },
            {
              &quot;variableKey&quot;: &quot;income&quot;,
              &quot;variableValue&quot;: &quot;string&quot;
            }
          ],
          &quot;signatories&quot;: [],
          &quot;notaries&quot;: []
        }
      ],
      &quot;notaries&quot;: []
    },
    &quot;guarantorDetails&quot;: {
      &quot;guarantors&quot;: [
        {
          &quot;variables&quot;: [
            {
              &quot;variableKey&quot;: &quot;guarantorName&quot;,
              &quot;variableValue&quot;: &quot;&quot;
            }
          ],
          &quot;notaries&quot;: []
        }
      ]
    },
    &quot;notaries&quot;: [
      {
        &quot;variables&quot;: [
          {
            &quot;variableKey&quot;: &quot;notaryName&quot;,
            &quot;variableValue&quot;: &quot;&quot;
          }
        ]
      }
    ]
  }
}</div></div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p></p><p class="slate-p " ></p>

The API Setup and Input Form creation section guides users on setting up authentication parameters to securely access the Loan Document application. By obtaining a unique clientId and clientSecret provided by Private Lender Law, users can generate a token for authenticating API calls. This section is essential for establishing a secure connection initiating API interactions, and correctly creating and updating loan documents within the application.

<p class="slate-p " >The request retrieves the<em class="slate-italic"> loan template</em>. This is the JSON Object that needs to be populated to create a <em class="slate-italic">loan document</em>. The <em class="slate-italic">loan template</em> that is retrieved is based on matching the <code class="slate-code">lenderName</code>,<code class="slate-code">state</code> and <code class="slate-code">category</code> properties.  The <code class="slate-code">variables</code> property MUST be passed with a NULL value.</p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " >The API endpoint is identical to the endpoint that creates and updates a <em class="slate-italic">loan document</em> in this version of the API. However, when the variables parameter is provided with a NULL value, the API will retrieve the JSON object associated with the <em class="slate-italic">loan template</em>, as opposed to attempting to create a  <code class="slate-code">loan document</code>.</p></div></div><p class="slate-p " >The loan template will always contain the following:</p><p class="slate-p " ><code class="slate-code">lenderName</code>: This is the lender name</p><p class="slate-p " ><code class="slate-code">category</code>: This is the type of loan document</p><p class="slate-p " ><code class="slate-code">state</code>: This is the state or province in North America</p><p class="slate-p " >The combination of these three parameters is used to <em class="slate-italic">identify</em> the correct <em class="slate-italic">loan template</em>.</p><p class="slate-p " >In addition to the above parameters the loan template contains a <code class="slate-code">variables</code> block that  has the follwing objects defined as arrays:</p><p class="slate-p slate-indent-0" style="0px"><code class="slate-code">inputVariables</code>: This conatins specic details  about the loan being requested</p><p class="slate-p slate-indent-0" style="0px"><code class="slate-code">borrowerDetails</code>: This contains name and address information about the borrower and the notaries associated with the borrower</p><p class="slate-p slate-indent-0" style="0px"><code class="slate-code">guarantorDetails</code>: This contains name and address information about the guarantor and the notaries associated with the guarantor</p><p class="slate-p slate-indent-0" style="0px"><code class="slate-code">notaries</code>: This contains name and address information about the  notraies involved in processing the loan</p><p class="slate-p " ></p><p class="slate-p " ><span style="color:#FE0000">Note: variable keys can be defined with spaces.</span></p>

. This is the JSON Object that needs to be populated to create a 

 that is retrieved is based on matching the 

 property MUST be passed with a NULL value.

The loan template will always contain the following:

: This is the state or province in North America

The combination of these three parameters is used to 

In addition to the above parameters the loan template contains a 

 block that  has the follwing objects defined as arrays:

: This conatins specic details  about the loan being requested

: This contains name and address information about the borrower and the notaries associated with the borrower

: This contains name and address information about the guarantor and the notaries associated with the guarantor

: This contains name and address information about the  notraies involved in processing the loan

Note: variable keys can be defined with spaces.

lenderName

state

variables

Authorization

type

title

status

detail

instance

<p class="slate-p " ><p class="slate-p " >This provides a detailed description of the information needed to authenticate the AP{I, and process documents using the API endpoints. The functionality includes:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Creating a new Loan Document</div></li><li class="slate-li " ><div style="position:relative"><a href="Updating.loan" target="_self">Updating a loan</a> document</div></li><li class="slate-li " ><div style="position:relative">Getting a loan document by ID</div></li><li class="slate-li " ><div style="position:relative">Getting loan document issues by ID</div></li><li class="slate-li " ><div style="position:relative">Getting a list of all loan documents</div></li><li class="slate-li " ><div style="position:relative">Getting comments by loan document</div></li><li class="slate-li " ><div style="position:relative">Puting a comment on a loan document</div></li><li class="slate-li " ><div style="position:relative">Subscribing to notifications</div></li></ul></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " ></p></p><p class="slate-p " >This list all the API response codes and document status codes. The document status codess are used to show where a loan document is in the document  life-cycle.</p><p class="slate-p " ></p>

This list all the API response codes and document status codes. The document status codess are used to show where a loan document is in the document  life-cycle.

Sections