Get Customer Information

This request allows you to pull information about a customer.

General

The Customers entity holds a vast amount of information. As such, we've added an $expand parameter to this request which will allow you to view specific types of customer information. Here's what you need to know about this request:

  • There are several objects nested within the Customers entity. Each object can be expanded to view its information, and multiple objects can be expanded in a single request.
  • Here's a list of the objects nested within the Customers entity:
Nested Customer Objects
Object Description
CreditScore This holds a customer's credit score information from the three available credit reporting agencies.
CustomFieldValues This holds information for the custom fields associated with this customer.
Documents This holds information for the documents that have been associated with this customer.
Employer This holds information regarding the customer's employer.
Loans This holds information about the loans that are associated with this customer.
MailAddress This holds the customer's mailing address.
Notes This holds information for the notes that have been associated with this customer.
PaymentAccounts This holds the customer's payment profile information.
Phones This holds the customer's phone information.
PrimaryAddress This holds the customer's primary residency.
References This holds information regarding the customer's references.
SocialProfiles This holds the customer's social media profile information.

For additional information on this topic, take a look at our API – Getting Customer Information article.

And for an example of how customers work within the UI, take a look at our Customer Overview article.

Database

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

📘

Try It Instructions

We've provided some sample information here so you can simply hit the Try It button to receive a 200 response from this request.

However, if you'd like to experiment with different values, feel free to change the $expand parameter to view different customer information.

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