zillowLenderReviews

Retrieve the reviews for a specific lender.

Name	Type	Attributes	Description
partnerId	PartnerId		The client's partner ID.
nmlsId	NMLSID		The lender's NMLS ID.
companyName	string	optional len(value) <= 150	The company name of the lender. This must be provided for institutional lenders.
reviewLimit	int	optional value > 0 value <= 10	The maximum number of reviews to return. If not provided, the default is 3.

The client's partner ID.

The lender's NMLS ID.

The company name of the lender. This must be provided for institutional lenders.

The maximum number of reviews to return. If not provided, the default is 3.

Name	Type	Attributes	Description
profileURL	string		A URL to the lender's zillow.com profile.
reviewURL	string		A URL to create a review for the lender on zillow.com. Note: Review creation requires a zillow.com account.
totalReviews	int	value >= 0	The total number of published reviews the lender has received.
rating	float	optional value >= 0 value <= 5	The average rating of all the lender's published reviews. This value will not be present if the lender has no reviews.
reviews	LenderReviewPublic []		The lender's most recent reviews, up to the reviewLimit. Reviews are ordered from newest to oldest.

A URL to the lender's zillow.com profile.

A URL to create a review for the lender on zillow.com. Note: Review creation requires a zillow.com account.

The total number of published reviews the lender has received.

The average rating of all the lender's published reviews. This value will not be present if the lender has no reviews.

The lender's most recent reviews, up to the reviewLimit. Reviews are ordered from newest to oldest.

Value	Description
InvalidPartnerId	The specified partner ID is not valid.
UnauthorizedPartner	There is no partner with the specified ID, or the partner is not currently authorized to make API calls.
UnknownLender	There is no lender with the specified ID.

The specified partner ID is not valid.

There is no partner with the specified ID, or the partner is not currently authorized to make API calls.

There is no lender with the specified ID.

Type	Attributes
string	len(value) > 0 len(value) <= 254

Type	Attributes
int	value >= -2147483648 value <= 2147483647

Encoded review ID, like "LR-EXAMPLE".

Type
string

Star rating for lenders.

Type	Attributes
int	value >= 1 value <= 5

NMLS IDs are (signed) 32 bit integers.

Type
int32

Encoded partner ID, like "RD-EXAMPLE".

Type
string

Type	Attributes
int	value > 0

Encoded user ID (aka ZUID), like "ZUexampleexample".

Type
string

Type	Attributes
string	len(value) == 5

An individual's name.

Name	Type	Attributes	Description
firstName	string	optional len(value) > 0 len(value) <= 100	The first name, if any.
middleName	string	optional len(value) > 0 len(value) <= 100	The middle name or middle initial, if any.
lastName	string	optional len(value) > 0 len(value) <= 100	The last name, if any.
suffix	string	optional len(value) > 0 len(value) <= 10	The name suffix, if any.

The first name, if any.

The middle name or middle initial, if any.

The last name, if any.

The name suffix, if any.

A reviewer's display name.

Name	Type	Attributes	Description
individualName	IndividualName	optional	The reviewer's name from their profile. This value is only present if the user has allowed their name to be displayed.
screenName	string	optional	The reviewer's screen name.
displayName	string	optional	The reviewer's specified display name for this review, if provided.

The reviewer's name from their profile. This value is only present if the user has allowed their name to be displayed.

The reviewer's screen name.

The reviewer's specified display name for this review, if provided.

Name	Type	Attributes	Description
rating	LenderReviewRating	optional	The reviewer's overall rating of the lender. Note: This value is required when creating or updating a review.
closeDateSatisfaction	LenderReviewSatisfaction	optional nullable	The reviewer's statisfaction with the close date of the loan product. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.
interestRateSatisfaction	LenderReviewSatisfaction	optional nullable	The reviewer's statisfaction with the interest rate provided. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.
closingCostsSatisfaction	LenderReviewSatisfaction	optional nullable	The reviewer's statisfaction with the closing costs. This includes any points paid and other fees such as appraisal, title, escrow, etc. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.
title	string	optional nullable len(value) <= 256	A title for the lender review. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.
content	string	optional nullable len(value) <= 5000	The content (text) of the review. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.
displayName	string	optional nullable len(value) >= 3 len(value) <= 100	An optional display name for the author of the review. Passing `null` will delete the existing value.
zipCode	ZIPCode	optional nullable	The ZIP code location of the reviewer. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.
serviceProvided	LenderReviewServiceProvided	optional nullable	The service the lender provided to the reviewer. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.
loanProgram	LoanProgram	optional nullable	The provided loan program. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.
loanPurpose	LoanPurpose	optional nullable	The purpose of the provided loan. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.
loanType	LoanType	optional nullable	The type of the provided loan. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.
dateOfService	date	optional nullable	The month/year of service. This must be the current month or earlier. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.
details	LenderReviewDetail []	optional nullable	Reviewer-provided details about their specific situation. Passing `null` will delete the existing value.
location	RegionInformation	optional	The reviewer's ZIP code location information.
reviewId	LenderReviewId	optional	The encoded lender review ID.
created	datetime	optional	The date/time when the review was created, formatted as an ISO-8601 datetime.
updated	datetime	optional	The date/time when the review was last edited by the author, formatted as an ISO-8601 datetime.
reviewerName	LenderReviewer	optional	The reviewer's name for display.
verifiedReviewer	bool	optional	Is the review associated with a lender contact?
individualReviewee	LenderReviewSubject	optional	The reviewed individual, if one is associated with the review.
companyReviewee	LenderReviewSubject	optional	The reviewed company, if one is associated with the review.
response	LenderReviewResponsePublic	optional	A lender-provided response, if one exists.

The reviewer's overall rating of the lender. Note: This value is required when creating or updating a review.

The reviewer's statisfaction with the close date of the loan product. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.

The reviewer's statisfaction with the interest rate provided. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.

The reviewer's statisfaction with the closing costs. This includes any points paid and other fees such as appraisal, title, escrow, etc. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.

A title for the lender review. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.

The content (text) of the review. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.

An optional display name for the author of the review. Passing `null` will delete the existing value.

The ZIP code location of the reviewer. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.

The service the lender provided to the reviewer. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.

The provided loan program. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.

The purpose of the provided loan. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.

The type of the provided loan. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.

The month/year of service. This must be the current month or earlier. This value is optionally provided by the reviewer and may not be returned when requested. Passing `null` will delete the existing value.

Reviewer-provided details about their specific situation. Passing `null` will delete the existing value.

The reviewer's ZIP code location information.

The encoded lender review ID.

The date/time when the review was created, formatted as an ISO-8601 datetime.

The date/time when the review was last edited by the author, formatted as an ISO-8601 datetime.

The reviewer's name for display.

Is the review associated with a lender contact?

The reviewed individual, if one is associated with the review.

The reviewed company, if one is associated with the review.

A lender-provided response, if one exists.

Describes a lender review response. Note: A response may be authored by a different account from the reviewed lender.

Name	Type	Attributes	Description
content	string	nullable len(value) > 0 len(value) <= 5000	The response content. A value of `null` indicates the response was deleted.
authorId	UserId		The encoded ID of the response author.
created	datetime		The date when the response was created, formatted as an ISO-8601 datetime.
updated	datetime		The date when the response was updated, formatted as an ISO-8601 datetime.

The response content. A value of `null` indicates the response was deleted.

The encoded ID of the response author.

The date when the response was created, formatted as an ISO-8601 datetime.

The date when the response was updated, formatted as an ISO-8601 datetime.

The subject of a lender review.

Name	Type	Attributes	Description
individualName	IndividualName	optional	The reviewer's name from their profile. This value is only present if the user has allowed their name to be displayed.
screenName	string	optional	The reviewer's screen name.
displayName	string	optional	The reviewer's specified display name for this review, if provided.
id	UserId	optional	The user ID (ZUID) of the actor.
emailAddress	EmailAddress	optional	The actor's email address. Certain special accounts may not have an associated email address (e.g. the auto-moderation account). This value is only present for callers with moderate review permissions.
nmlsId	NMLSID		The subject's NMLS ID.
nmlsType	NMLSType		The type of the lender.
currentlyRepresentsCompany	bool	optional	Is the individual currently authorized to represent the company? This value is only provided for individual lenders and only when a company is also associated with the review
companyName	string	optional	The company name of the lender. This value is only provided for companies.

The reviewer's name from their profile. This value is only present if the user has allowed their name to be displayed.

The reviewer's screen name.

The reviewer's specified display name for this review, if provided.

The user ID (ZUID) of the actor.

The actor's email address. Certain special accounts may not have an associated email address (e.g. the auto-moderation account). This value is only present for callers with moderate review permissions.

The subject's NMLS ID.

The type of the lender.

Is the individual currently authorized to represent the company? This value is only provided for individual lenders and only when a company is also associated with the review

The company name of the lender. This value is only provided for companies.

Hierachical information about a region.

Name	Type	Attributes	Description
regionId	RegionId		The region ID of the region.
name	string		The name of the region.
displayName	string		The display name of the region.
type	RegionType		The type of the region.
latitude	float		The latitude of the region's centroid. This is approximate, and may be 0.0 if the data is unavailable.
longitude	float		The longitude of the region's centroid. This is approximate, and may be 0.0 if the data is unavailable.
zipCodeRegionId	RegionId	optional	The region ID of the ZIP code, for ZIP code regions, or the primary ZIP code region ID of the region, if present.
zipCode	string	optional	The canonical ZIP code name, for ZIP code regions, or the primary ZIP code of the region, if present.
stateRegionId	RegionId	optional	The region ID of the state the contains the region or a majority of the region.
stateName	string	optional	The full name of the state that includes the region or a majority of the region; for example, "California".
stateAbbreviation	StateAbbreviation	optional	The state abbreviation of the state that includes the region or a majority of the region; for example, "CA".
countyRegionId	RegionId	optional	The region ID of the county that includes the region or a majority of the region.
countyName	string	optional	The name of the county that includes the region or a majority of the region.
cityRegionId	RegionId	optional	The region ID of the city that includes the ZIP code. This member will not be present if the location is not known to be in a city or town.
cityName	string	optional	The name of the city that includes the region or a majority of the region. This member will not be present if the location is not known to be in a city or town.
metroRegionId	RegionId	optional	The region ID of the metro area that includes the region or a majority of the region. This member will not be present if the location is not known to be in a metro area.
metroName	string	optional	The name of the metro area that includes the region or a majority of the region. This member will not be present if the location is not known to be in a metro area.

The region ID of the region.

The name of the region.

The display name of the region.

The type of the region.

The latitude of the region's centroid. This is approximate, and may be 0.0 if the data is unavailable.

The longitude of the region's centroid. This is approximate, and may be 0.0 if the data is unavailable.

The region ID of the ZIP code, for ZIP code regions, or the primary ZIP code region ID of the region, if present.

The canonical ZIP code name, for ZIP code regions, or the primary ZIP code of the region, if present.

The region ID of the state the contains the region or a majority of the region.

The full name of the state that includes the region or a majority of the region; for example, "California".

The state abbreviation of the state that includes the region or a majority of the region; for example, "CA".

The region ID of the county that includes the region or a majority of the region.

The name of the county that includes the region or a majority of the region.

The region ID of the city that includes the ZIP code. This member will not be present if the location is not known to be in a city or town.

The name of the city that includes the region or a majority of the region. This member will not be present if the location is not known to be in a city or town.

The region ID of the metro area that includes the region or a majority of the region. This member will not be present if the location is not known to be in a metro area.

The name of the metro area that includes the region or a majority of the region. This member will not be present if the location is not known to be in a metro area.

A reviewer's self-reported borrowing situation.

Value	Description
LowCredit	The borrower had below average credit.
SelfEmployed	The borrower was self-employed.
FirstTimeBuyer	This was the borrower's first home purchase.
NewConstruction	The loan was used for a new construction purchase.

The borrower had below average credit.

The borrower was self-employed.

This was the borrower's first home purchase.

The loan was used for a new construction purchase.

A reviewer's satisfaction rating.

Value	Description
DidNotMeetExpectations	The lender did not meet expectations.
MetExpectations	The lender met expectations.
ExceededExpectations	The lender exceeded expectations.

The lender did not meet expectations.

The lender met expectations.

The lender exceeded expectations.

The service provided to the reviewer.

Value	Description
NoResponse	The lender never responded to the reviewer.
DidNotContinue	The reviewer did not choose to continue with the lender.
PreQualified	The reviewer was pre-qualified for a loan with the lender.
LoanInProgress	The reviewer has a loan in progress with the lender.
LoanClosed	The reviewer closed a loan with the lender.

The lender never responded to the reviewer.

The reviewer did not choose to continue with the lender.

The reviewer was pre-qualified for a loan with the lender.

The reviewer has a loan in progress with the lender.

The reviewer closed a loan with the lender.

Types of loan program that a borrower can express interest in. These values are not comprehensive or orthogonal.

Value
Fixed30Year
Fixed20Year
Fixed15Year
Fixed10Year
ARM3
ARM5
ARM7
HomeEquity30Year
HomeEquity30YearDueIn15
HomeEquity15Year
HELOC20Year
HELOC15Year
HELOC10Year
LowOrNoDown
InterestOnly

The purpose of a loan.

Value	Description
Purchase	A purchase loan.
Refinance	A refinance loan.
HomeEquity	A home-equity loan.
Construction	A construction (building) loan. This is a loan used to finance the actual construction of the home.
HELOC	A home-equity line of credit.

A construction (building) loan. This is a loan used to finance the actual construction of the home.

A home-equity line of credit.

The loan type reported in a lender review.

Value
Conventional
FHA
VA
USDA
Other
Jumbo

Value
Company
Individual

Value	Description
Country
State
County
City
ZIPCode
Neighborhood
Road
Metro
Borough
Community
Subdivision
Other	Catchall for all other region types.

Catchall for all other region types.

US state and territory abbreviations.

Value	Description
AK	Alaska
AL	Alabama
AR	Arkansas
AS	American Samoa
AZ	Arizona
CA	California
CO	Colorado
CT	Connecticut
DC	Washington, D.C.
DE	Delaware
FL	Florida
GA	Georgia
GU	Guam
HI	Hawaii
IA	Iowa
ID	Idaho
IL	Illinois
IN	Indiana
KS	Kansas
KY	Kentucky
LA	Louisiana
MA	Massachusetts
MD	Maryland
ME	Maine
MH	Marshall Islands
MI	Michigan
MN	Minnesota
MO	Missouri
MP	Northern Mariana Islands
MS	Mississippi
MT	Montana
NC	North Carolina
ND	North Dakota
NE	Nebraska
NH	New Hampshire
NJ	New Jersey
NM	New Mexico
NV	Nevada
NY	New York
OH	Ohio
OK	Oklahoma
OR	Oregon
PA	Pennsylvania
PR	Puerto Rico
RI	Rhode Island
SC	South Carolina
SD	South Dakota
TN	Tennessee
TX	Texas
UT	Utah
VA	Virgina
VI	Virgin Islands
VT	Vermont
WA	Washington
WI	Wisconsin
WV	West Virginia
WY	Wyoming

Northern Mariana Islands

zillowLenderReviews

Input Parameters

Output Parameters

Error Codes

Typedefs

typedef EmailAddress

typedef int32

typedef LenderReviewId

typedef LenderReviewRating

typedef NMLSID

typedef PartnerId

typedef RegionId

typedef UserId

typedef ZIPCode

Struct Types

struct IndividualName

struct LenderReviewer

struct LenderReviewPublic

struct LenderReviewResponsePublic

struct LenderReviewSubject

struct RegionInformation

Enum Types

enum LenderReviewDetail

enum LenderReviewSatisfaction

enum LenderReviewServiceProvided

enum LoanProgram

enum LoanPurpose

enum LoanType

enum NMLSType

enum RegionType

enum StateAbbreviation