Posting Details

Post Method	HTTP POST
URL	The URL will be provided in the initial email you received.
Data Format	JSON

Posting Fields

#	Field Name	Required	Value Type	Description
1	leadProviderName	Yes	string	Lead Provider Name
2	filterID	No	string	Filter ID
3	firstName	Yes	string	First Name
4	lastName	Yes	string	Last Name
5	email	Yes	string	Email
6	phoneNumber	Yes	string	Phone Number
7	cellPhoneNumber	Yes	string	Cell Phone
8	zipCode	Yes	string	Zip Code
9	state	Yes	string	State
10	propertyStreetAddress	Yes	string	Property Street Address
11	propertyCity	Yes	string	Property City
12	propertyState	Yes	string	Property State
13	propertyCounty	No	string	Property County
14	propertyZip	Yes	string	Property Zip
15	propertyType	Yes	string*	*See below for applicable values.
16	propertyUse	Yes	string*	*See below for applicable values.
17	loanPurpose	Yes	string*	*See below for applicable values.
18	creditRating	Yes	string*	*See below for applicable values.
19	loanAmount	Yes	string	Loan Amount
20	downPayment	Yes	string	Down Paynent
21	purchasePrice	Yes	string	Purchase Price
22	loanPercentage	Yes	string	Loan Percentage
23	cashOutAmount	No	string	Cash Out Amount
24	mortgageBalance	No	string	Mortgate Balance
25	mortgageRate	No	string	Mortgage Rate
26	servedInMilitary	Yes	bool	Has borrower served in Military?
27	workingWithRealEstateAgent	Yes	bool	Is borrower working with REA?
28	selectedProperty	Yes	bool	Has borrower selected a property?
29	leadID	Yes	string	The lead ID from your system.

Note: If you have additional fields to pass not included in the above, please send these to us in an email along with the possible values for those fields.

List Values

Property Type

#	Value
1	Attached_SFR
2	Detached_SFR
3	Condo
4	Co_Op
5	High_Rise
6	Manufactured
7	Multi_Unit
8	PUD
9	Townhouse

SFR: Single Family Residence

PUD: Planned Unit Development

Property Use

#	Value
1	Primary
2	Secondary
3	Investment

Loan Purpose

#	Value
1	Purchase
2	Refinance

Credit Rating

#	Value
1	Excellent
2	Good
3	Fair
4	Poor
5	NA

JSON Sample

  {
    "leadProviderName": "LeadVendorInc",
    "firstName": "Nate",
    "lastName": "DaGreat",
    "email": "nate@dagreat.com",
    "phoneNumber": "2005555555",
    "cellPhoneNumber": "2006666666",
    "zipCode": "90021",
    "state": "CA",
    "propertyStreetAddress": "123 Fake. St.",
    "propertyCity": "Los Angeles",
    "propertyState": "CA",
    "propertyCounty": "Los Angeles",
    "propertyZip": "90021",
    "propertyType": "Attached_SFR",
    "propertyUse": "Primary",
    "loanPurpose": "Purchase"
    "creditRating": "Excellent",
    "loanAmount": "500000",
    "downPayment": "70000",
    "purchasePrice": "750000",
    "loanPercentage": "5",
    "cashOutAmount": "5000",
    "mortgageBalance": "200000",
    "mortgageRate": "10.32",
    "servedInMilitary": false,
    "workingWithRealEstateAgent": true,
    "selectedProperty": true
  }

Post Response Sample

State	Response
Success	<response><result>Success</result><url>https://www.thebrokernetwork.com/Client/PreQual/Default.aspx?cid=xxxxxxxx-fb32-48e4-a6fe-xxxxxxxxxx</url></response>
Duplicate	<response><result>Duplicate</result><url>https://www.thebrokernetwork.com/Public/[VendorName]App.aspx</url></response>