Search Customers

This endpoint allows you to search and filter customers based on specified criteria.

General

Searching by customer information is a common lending request. Here's what you need to know:

  • This request uses Elasticsearch to filter your results and returns only the customers who match your search criteria.
  • The search example we've set up here returns a specific customer, but searches can be much more broad.
  • Many users search and filter customers by Social Security Number. If you'd like to do this, you can do so by using the ssn field which is nested within the Customer entity.

For more information on Elasticsearch and searching in general, take a look at our API – Searching Customers and Elasticsearch Customer Mappings articles.

For an example on how searching works within the UI, take a look at our Customer Manager article.

Database

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

{
     "query": {
          "bool": {
               "must": {
                    "match": {
                         "firstName": "API"
                    }
               },
               "filter": {
                    "range": {
                         "birthDate": {
                              "gte": "1961-11-01",
                              "lte": "1961-11-30"
                         }
                    }
               }
          }
     }
}
{ 
   "query":{ 
      "bool":{ 
         "must":[ 
            { 
               "bool":{ 
                  "should":[ 
                     { 
                        "query_string":{ 
                           "fields":[
                              "ssn"
                           ],
                           "query":  "151651566"
                        }
                     }
                  ]
               }
            }
         ]
      }
   }
}

📘

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.

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