Get Promises

This request allows you to pull a loan's Promises information.


If a lender issues a bit of good will towards a customer, they can use Promises to keep track of the customer's end of the deal. Here's what you need to know about this request:

  • The Promises object holds promise information, and it's nested within the Loans entity.
  • Promises help users keep track of agreements, and they can be automatically fulfilled by a determined set of criteria. They can also be manually edited to mark they've been fulfilled.
  • When you create a promise, you will use a YYYY-MM-DD format; but when you pull a loan's promise information, you'll notice that the dates in the response payload are in Unix epoch format.

For an example of how promises work within the UI, take a look at our Promises Overview article.


For information on promises database tables, see the following articles:


Try It Instructions

Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is ready for you—hit Try It to send the request.

However, if you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.

Click Try It! to start a request and see the response here!