All Categories > LMS API
How to get started with the LoanPro API.
7 articles by 3 authors
Articles with information regarding the use of Elasticsearch in LoanPro
3 articles by 2 authors
These articles list all the collections for various fields.
38 articles by 3 authors
This article explains how to use the API to update source company information.
Updated 2 weeks ago by Nate Christensen
This article explains how to use the API to get information on Actions and Results. It also explains how to assign Actions and Results to loans and pull reports.
Updated 1 week ago by Cole
This article explains how to activate a loan using the API.
Introduction. This article assumes that you have an existing loan. If not, see Creating a Loan with the API. LoanPro's latest release includes a breaking change in the use of collateral through the A…
This article explains how to use the API to add insurance to a loan.
This article explains how to add and update nested entities. It builds on the information from our articles on Nested Entities , API – Updating Entities , and API – Expanding objects.
Introduction. Many entities will require address information, and this information can be added or updated either within the UI or through the API, which this article covers. Often, to set the addres…
Updated 4 days ago by Jackson Stone
This articles explains how to use the API to log loan advancements and credits.
Updated 1 week ago by Sloan
This article explains how to change amount past due for a loan with the API.
General. The API may send transactional warnings in certain circumstances. A warning will result in an error message that looks similar to the following: { "error": { "message":"Transaction warnings…
This article explains how to change the due date of a loan with the API.
This article explains how to create a bankruptcy filing on a loan through the API.
Updated 1 week ago by Darrin Wray
Introduction. To create a payment profile in LoanPro, you will need to create a customer if the customer the you want to link the payment profile to doesn’t exist. Next, you should create the payment…
Updated 1 week ago by Andy
Introduction. Loans in LoanPro are detailed. They include information about insurance , loan settings , loan setup , collateral, etc. As a result, payloads for creating a loan are broken into several…
Updated 2 days ago by Andy
This article describes how to use the API to create a new Source Company and describes each parameter in the payload of the request.
This article explains how to use the API to create AutoPays.
Updated 4 days ago by Andy
This article will cover the basics of how to create a query object for Autopays. It assumes you are familiar with the items discussed in API – Autopay collections.
General. Creating charges is done through the API by sending a PUT request to the loan on which the charge will be added. This article assumes you already have an existing loan. If not, see Creating…
Updated 4 days ago by Sloan
This article describes how to use the API to create loan and customer notes.
This article explains how to create a customer through the API.
This article explains how to pull and update credit scores through the API.
Edit an entity's custom fields through the API.
This article will show you how to use the API to initiate custom form downloads.
This article explores how to add or edit a customer's phone number through the API. For a more general overview on how phones are used in LoanPro, see our article on Customer Phone Numbers.
General. This article explores how to add or edit a customer's references through the API. For a more general overview on how references are used in LoanPro, see our article on References. To add a r…
This article details your options for bypassing transaction warnings when using the API.
General. Through the API you can easily create a dedicated login page or add a login area to an existing website. How To. To log the user into the customer-facing website, first send the user credent…
This article explains how dates are formatted in the LoanPro API.
General. This article is going to go over adding days past due in the API. Adding DPD Adjustment. To adjust the days past due settings for a loan, send a PUT request to the desired loan. Below is a s…
This article explains how to delete loans.
General. The deletion operation is very straight-forward, and can be done using a DELETE request. The only thing to take into consideration is that the requested entity MUST implement the “delete” me…
This article explains how to delete a customer through the API.
General. In the event that you wish to mark a particular phone number as Do Not Call, you can do this through the API or by changing the status in the UI. If you wish to make the change in the UI, re…
Updated 4 days ago by Cole
This article describes how to use DocuSign with the API.
Introduction. This article explains how to upload documents through the API, but you can also upload common and customer-specific documents within the LoanPro UI. Uploading a document through the API…
Introduction. This article covers how to download the contents of an uploaded document. To learn about how to upload, update, or create documents please see the article API – Documents. Note: When yo…
This article covers how to download the contents of an uploaded document.
General. This article assumes you have read the following articles: API – Creating Charges. API – Updating Entities. When updating a charge, there is one extra field that needs to be set. This field…
This article explains how to send an email to a list of loans using the email tool endpoint.
This article explains how to use the API to create and edit a customer's employer information.
The endpoint, method, and payload for the new funding process, adding in the June 2021 release.
Updated 1 week ago by Jackson Stone
This article discusses what kind of a response you can expect to see when you get an error response returned form the API.
Introduction. This article is going to go over adding escrow adjustments in the API. Adding a New Escrow Adjustment. To add a new escrow adjustment for a loan, send a PUT request to the URL for the l…
This article goes over how to create escrow calculators in the API.
This article explains how to use the API to edit escrow subset options.
Introduction. This article is going to go over adding a new escrow transaction for a loan in the API. Adding a New Escrow Transaction. Try it on ReadMe To add a new escrow transaction for a loan, sen…
At various times in using the API, it will return URL references to various objects instead of the actual object data itself. Such requests occur most often when getting entity information. This article will explain how to expand objects to get the information you need.
General. This article assumes that you have read API – Creating Autopay Query Objects. This article is going to go over exporting an EFT file in the API. Format. The URL to export an EFT file is as f…
Introduction. Several LoanPro API endpoints use OData so you can filter your results without having to use an Elasticsearch object. Any endpoint that includes /odata.svc/ works with OData functionali…
Use the UI to find a loan or customer ID.
This article discusses how to get admin stats through an API call.
General. This article is going to go over how to GET computation fields in the API. If you want to see the list of computation fields for your company, you can use the following endpoint: GET https:/…
This article explains how to use the API to retrieve customer bank information.
Updated 1 week ago by Nate Christensen
This article explains how to use the odata.svc/Customers endpoint to get customer information.
Introduction. This article will explore the different endpoints you can use to retrieve loan information. Understanding the process will require some knowledge of the API, which you can learn with ou…
General. This article will discuss pulling tenant settings. This does not allow for changing any of these settings, just viewing them. Base Request. The base request is a GET request to the URL https…
Introduction. This article explains how to link loans through the API. For more info on how to link loans loans in the UI, see our article on Account Linking. Linking Loans. To link two loans with th…
Introduction. This article explains how to link and unlink customers through the API. For a general overview of linking and how to do it in the UI, see our article on Account Linking. Linking a Custo…
This article covers modifying checklist items for existing loans. You can configure checklists in the UI or through the API, which this article covers.
General. Try it on ReadMe This article explains how to fund a loan through the API. For more information regarding loan funding in general or the process in the UI, see Fund a Loan. How to Fund a Loa…
Introduction. This article covers assigning a loan to a portfolio/subportfolio and removing a loan from a portfolio/subportfolio. You can do this in the UI , but this article shows how to do the same…
This article covers how to configure loan settings in the API.
This article discusses the specifics of the setup of a loan, working with loan setup entities, and what entity fields refer to.
This article explains how to log a charge-off through the API.
This will only log a payment. Logging a payment is simply making a record of a transaction that occurred on a loan. This will not pull any money from a card or an account but will create a record of…
Introduction. Before you can make a payment through the API you must have a loan and a customer set up in LMS. This process is explained here: Create a Loan - Full Process article as well as in the B…
Introduction. This is a list of miscellaneous endpoints that don’t require any special parameters. Just replace {id} with the ID of the corresponding entity (and see our article on Finding Loan and C…
Introduction. You can modify a loan either within the UI , or through the API. To modify a loan in the API, follow these steps: Look for transactions that are after the modification date (optional).…
General. The National Automated Clearing House Association (NACHA) set a specific format for formatting E-checks, which includes a set of codes for returned payments. These return codes act as a shor…
General. Customers who use NACHA files to process transactions will often want to do something like the following: Pull a Payment History Report from LoanPro. Create a NACHA file outside of Secure Pa…
This article explains the concept of nested entities; if you want to learn how to incorporate them into you API requests, you can visit the article API – Getting Loan Information.
General. LoanPro has an endpoint that specifically lets the user get the originally-calculated amortization schedule on a loan. A separate endpoint makes retrieving this information easy. The endpoin…
This article explains how to use endpoint paging parameters to filter the information you receive from requests.
Updated 1 week ago by Cody H
General. Creating an AutoPay on a parent loan requires additions to the typical AutoPay Payload. To create an AutoPay, use the request: PUT https://loanpro.simnang.com/api/public/api/1/odata.svc/Loan…
General. Parent-child loan linking functionality lets you designate multiple loans as the child of a single loan. When transactions are posted to the parent loan, a transaction is also posted to each…
Updated 6 months ago by Cole
General. Logging a payment on a parent loan requires additions to the typical payment payload. To log a payment, use the request: PUT https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(id)…
Introduction. LoanPro’s payment report offers detailed information about payments made and which loans the payments were applied towards. Each time a payment report is pulled a query is used to speci…
General. With LoanPro, you can preview how a payment is applied before it is logged. To do this, send a POST request to a URL formatted as: https://loanpro.simnang.com/api/public/api/1/Loans(<id>)/Au…
Process a Payment - Processing a payment in LoanPro LMS will initiate a transaction that will actually pull money from the customer's card or account. This will create a record of the transaction jus…
General. LoanPro allows you to track your customers' promises to pay. We have several articles explaining how to use promises in the LoanPro UI , and this one explains how to use the API. Creating a…
Introduction. This article assumes that you have read API Query Objects. A lot of data in LoanPro is stored in strings, and often times you don’t care about an exact string match. Rather, you want to…
Introduction. LoanPro uses ElasticSearch to perform a large portion of searches. This means that the queries used by LoanPro closely resemble the queries used by Elastic search. This article will go…
Introduction. This article assumes that you have read API Query Objects. At times, while performing a search, you’ll want to not only filter by entities that you are pulling for results, but also lin…
Introduction. This article assumes you have read API – Create a Loan. A Quick Quote is a temporary loan account that will last at least until midnight. After that, it will be deleted from the system…
General. This article is going to go over updating a recurring charge on a loan in the API. Updating Recurrent Charges for a Loan. To update a recurring charge on a loan, send a PUT request to the UR…
Introduction. Payment reversal in LoanPro will mark a payment as reversed, and will then optionally forward it on to payment processors for voiding. This article explains how to reverse payments thro…
General. This article is going to go over roll payment in the API. Preview Roll Payment. To preview a roll payment, send a GET request to: https://loanpro.simnang.com/api/public/api/1/Loans(<id>)/Aut…
General. Rules Applied can make changes to Loan Settings. You can configure which rules will trigger which changes either using the UI or through the LoanPro API, which is explained here. To change a…
Introduction. For information about Schedule Rolls and what the options do, see Roll Schedule Templates. Schedule Roll. Adding New Schedule Line. To add a new schedule line, send a PUT request to the…
General. Sometimes, it is easiest to find a specific customer by their SSN. This can be done through the API by sending a POST request to the following endpoint: https://loanpro.simnang.com/api/publi…
In the LoanPro UI, you can search for customers from Users > Customer Manager. This article will explain how to search through the API. To search customers a POST request is sent to the Customers/Aut…
Updated 5 months ago by Cole
Introduction. Much like how you can search loans in the UI , you can also search them through the API. To search loans, a POST request is sent to the Loans/Autopal.Search() endpoint, often with reque…
General. This article will discuss how to send emails using the API, but it can also be done through the UI. There are two steps. The first one is to create an email tool entity, and then the other o…
General. When customers have multiple payment profiles set up, one of them will need to be set as the primary profile. This can be done either with the Customer Manager tool in the UI , or through th…
Introduction. LoanPro provides the ability to split payments across linked loans, which provides for many useful tools. This article assumes you have read API – Logging a Payment. Preview Split. To p…
Introduction. For basic info and how it works in the UI, see our article on Suspending Payments. Suspending. To suspend forecast payments, send a POST request to a URL formatted as follows: https://l…
General. In LoanPro, you can suspend interest on a loan for a time, or later resume that interest. Our article Suspend/Resume Interest Accrual explains the basics and how to use the tool in the UI, a…
General. While not possible inside the LoanPro UI, you can add a system note directly, using the LoanPro API. This is most often helpful when adding customer communication history notes. This article…
Introduction. The Targeted APR feature calculates loan values that will have the APR for a loan be approximately equal to the target APR. The APR estimates will be equal to or less than the target AP…
General. This will go over getting tenant files in the API. Getting Tenant Files. To get a list of tenant files, send a GET request to the following URL: https://loanpro.simnang.com/api/public/api/1/…
Introduction. The purpose of transaction warnings it to help users avoid creating duplicate data within the system. The decision to return a transaction warning is based on a comparison of key pieces…
This article explains how to use the API to update Loan alerts.
General. This article explains how to use the API to update merchant processor groups. You can also do this through the UI. To update the merchant processor group using the LoanPro API, you simply ne…
Introduction. This article explains how to update payment profiles through the API, but we also have articles show how to make changes within the LoanPro UI or the Secure Payments UI. LoanPro uses Se…
General. This article covers the basics for updating a customer using the LoanPro API. Update a Customer. To update a customer, send a PUT request to the following URL. PUT https://loanpro.simnang.co…
General. In the API, all updates are made via a PUT request. To update an item, follow the same steps as creating the item with a few additions: In each LoanPro object, you must include the following…
General. This article assumes you have read the following articles: Payment Defaults. API – Logging a Payment. API – Processing a Payment. API – Updating Entities. When updating a payment, there is o…
General. LoanPro is integrated with tools that can verify with the postal service that an address is real. Our main article on USPS Address Verify & Validate explains how these tools work and how to…
What is an import, and how does it work in the API? Imports let you move a large body of data into LoanPro much faster than the regular user interface would allow (and with a lot less work, as well).
Updated 2 months ago by Jackson Stone
General. LoanPro's Swagger documentation shows each endpoint, an example of how to send a request, and information about payloads and responses. The full site can be accessed at https://loanpro.simna…
Updated 4 months ago by Cole
General. LoanPro enterprise clients have often created their own middleware in order to facilitate servicing for their employees. This middleware often includes is an integration with telephony servi…
Updated 6 months ago by Andy
Powered by HelpDocs (opens in a new tab)
Updated 2 days ago
by Andy
