Search Loans

This endpoint searches for loans that match specified criteria.

General

Searching and filtering loan information is a common lending request. Here's what you need to know about searching for loans:

  • Instead of a GET, this search uses a POST request. This allows you to add a payload body that filters for loans that match your criteria. Meanwhile, the parameters in the endpoint let you specify how you want the results displayed—how many entries, how they should be ordered, where to start, and which objects to expand.
  • Pulling large amounts of loan information this way can take some time. If you have vast amounts of loan data, we suggest using a database query instead if the option is available to you.

For more information on searchable criteria, our Elasticsearch Loan Mappings article provides a full list of the filters you can use with this request.

For an example of how searching works within the UI, take a look at our Advanced Search Options article.

Database

For information regarding loan database tables, see the following articles:

{
     "query": {
          "bool": {
               "must": {
                    "match": {
                         "loanAmount": 10000
                    }
               },
               "filter": {
                    "range": {
                         "contractDate": {
                              "gte": "2020-10-01",
                              "lte": "2020-10-31"
                         }
                    }
               }
          }
     }
}

📘

Try It Instructions

Our pages often provide sample payload information so that you can try requests yourself. This request is ready for you—hit ‘Try It’ to send the request.

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.

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