Search Customers

This request searches for customers that match specified criteria.

   Click here to learn more about this request

❗️

LoanPro is transitioning from Elasticsearch to OpenSearch.

For more information, including timelines and a guide for ensuring your integrations continue to work as intended, see OpenSearch Migration ↗

Searching for Customer Profiles

Search queries can be used to locate customer information that match specific criteria:

• This request uses Elasticsearch to filter results and returns only the customers who match the 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. 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 of how searching works within the UI, take a look at our Customer Manager article.

Database

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

• Database – Customer Main Table (customer_entity)
• Database – Customer Status Entity (customer_status_entity)

Search by customer name

{
     "query": {
          "bool": {
               "must": {
                    "match": {
                         "firstName": "API"
                    }
               },
               "filter": {
                    "range": {
                         "birthDate": {
                              "gte": "1961-11-01",
                              "lte": "1961-11-30"
                         }
                    }
               }
          }
     }
}

Search by SSN

{ 
   "query":{ 
      "bool":{ 
         "must":[ 
            { 
               "bool":{ 
                  "should":[ 
                     { 
                        "query_string":{ 
                           "fields":[
                              "ssn"
                           ],
                           "query":  "151651566"
                        }
                     }
                  ]
               }
            }
         ]
      }
   }
}