> For the complete documentation index, see [llms.txt](https://even-financial.gitbook.io/developer-center/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://even-financial.gitbook.io/developer-center/marketplace-integrations/partner-pages/mortgage-marketplace.md).

# Mortgage Marketplace

How to get started with an Engine by MoneyLion marketplace Partner Page integration for Mortgage

## Standard Partner Page Implementation

All Partner Pages utilize custom URLs and tracking to ensure all transactions are correctly attributed. To integrate the Partner Pages on your website, you would place the following URL on your page in your desired location.

{% hint style="info" %}
**PLEASE NOTE:** Your Engine representative will provide you with your specific partner page URL. Do not try to reproduce from the sample URL outlined below.
{% endhint %}

```
https://moneylion.com/network/{channel}/{zone}/
```

### URL Components

* **Channel**: placeholder that will be replaced with precise values in the embed code provided to you.
* **Zone**: placeholder that will be replaced with precise values in the embed code provided to you.

If implementing using an anchor tag, you may consider having the link open in a new tab with a `target="_blank"` attribute:

```html
<a href="https://moneylion.com/network/{channel}/{zone}/" target="_blank">Desired Link Text</a>
```

### Brand Customization

All Partner Pages can be co-branded with your company logo and colors to deliver a seamless customer journey. The headline is also customizable (with Engine by MoneyLion compliance approval).

## The Consumer Experience

Engine's Mortgage embed covers **purchase, refinance, and home equity (HELOC and HELOAN).** The embed renders three surfaces, and your zone configuration decides which one the consumer lands on first:

* **Explore.** A rate-trend chart built on current APR data. It shows how rates have moved rather than listing offers, so a consumer can arrive with no information and still see something useful. Its call-to-action hands off to Search.
* **Search.** The question flow that qualifies the consumer and ends by creating an offer search with Engine's lending partners.
* **Compare.** The results page for that offer search. The consumer can sort the offers, page through them, and narrow them with filters, and each offer's call-to-action sends the consumer to that lender. Compare is the last Engine screen in the flow.

**Your Engine representative will provide a link to either the Explore or Search Partner Page.** Compare is not available as an entrypoint, because the page is scoped to the offer search that Search created - the only way to reach it is to complete the question flow.

**Which filters appear on Compare depends on the mortgage type.** Purchase and refinance offers can be narrowed by loan term and by FHA and VA program eligibility. Home equity offers can be narrowed by property value, current mortgage balance, and requested loan amount.

### Search Funnel Defined

Mortgage asks a different opening question than Engine's other marketplaces: the consumer states a goal - buying a home, refinancing, or borrowing against home equity - and that answer changes which questions follow.

<table><thead><tr><th width="194.37890625">Step</th><th>What the consumer provides</th></tr></thead><tbody><tr><td>Mortgage Information</td><td><p><strong>Purchase:</strong> goal, plus purchase price and down payment</p><p><strong>Refinance:</strong> property value and current mortgage balance</p><p><strong>Home Equity</strong>: property value, current mortgage balance, and desired loan amount</p></td></tr><tr><td>Zip Code</td><td>The property's ZIP code</td></tr><tr><td>Cash Out</td><td><strong>Refinance only.</strong> Whether the consumer wants cash out, or a rate-and-term refinance</td></tr><tr><td>Credit Score</td><td>Self-reported credit score range</td></tr><tr><td>Identity Verification</td><td>Date of birth and phone number</td></tr><tr><td>Contact Information</td><td>First name, last name, and email</td></tr><tr><td>Personal Information</td><td>Mailing address</td></tr><tr><td>SSN and Consents</td><td>Social Security Number, with FCRA and TCPA consent</td></tr></tbody></table>

**Not every consumer may see every step.** When Engine already has consumer data because identity verification returned i, the marketplace routes past those steps instead of asking again. Identity verification may also insert an SMS one-time-passcode step.

## Required Consumer Data Inputs

The Mortgage experience collects every field below itself, inside the Search funnel. Fields appear in the order the consumer meets them, matching the Search Funnel above.

A consumer is only asked for the fields belonging to the mortgage type they picked, and any step Engine can already satisfy - through identity verification - is skipped rather than asked again.

<table><thead><tr><th width="180">Name</th><th width="202.5927734375">Field Name</th><th width="247.1923828125">Description</th><th width="160">Required? Which Mortgage Product(s)?</th></tr></thead><tbody><tr><td>Mortgage Type</td><td><code>mortgageType</code></td><td>What the consumer wants to do. <strong>Values</strong>: <code>purchase</code>, <code>refinance</code>, <code>heloc</code>. Home equity submits <code>heloc</code> and leaves the lead's <code>mortgageType</code> unset.</td><td>All Mortgage Product Types</td></tr><tr><td>Purchase Price</td><td><code>purchasePrice</code></td><td>Purchase price of the home. Stored on the lead as <code>propertyValue</code>.</td><td>Purchase only</td></tr><tr><td>Down Payment</td><td><code>downPayment</code></td><td>Cash down payment, in dollars. Stored on the lead as <code>downPaymentAmount</code>.</td><td>Purchase only</td></tr><tr><td>Down Payment Percentage</td><td><code>downPaymentPercent</code></td><td>The same down payment expressed as a percentage of purchase price. Used by the form only; not stored on the lead.</td><td>Purchase only</td></tr><tr><td>Property Value</td><td><code>propertyValue</code></td><td>Current estimated value of the home.</td><td>Refinance and Home Equity</td></tr><tr><td>Current Mortgage Balance</td><td><code>loanBalance</code> (refinance)<br><code>mortgageBalance</code> (home equity)</td><td>Outstanding balance on the existing mortgage. Stored on the lead as <code>mortgageBalance</code> in both cases.</td><td>Refinance and Home Equity</td></tr><tr><td>Desired Loan Amount</td><td><code>desiredLoanAmount</code></td><td>Amount the consumer wants to borrow against their equity. Stored on the lead as <code>mortgageAmount</code>.</td><td>Home Equity only</td></tr><tr><td>Property ZIP Code</td><td><code>zipcode</code></td><td>ZIP code of the property being financed, collected on the Zip Code step. Distinct from the consumer's mailing ZIP. Stored on the lead as <code>propertyZipcode</code>, and Engine derives <code>propertyState</code> from it.</td><td>All Mortgage Product Types</td></tr><tr><td>Cash Out</td><td><code>cashOut</code></td><td>Whether the consumer wants cash out or a rate-and-term refinance. <strong>Values</strong>: <code>yes</code>, <code>no</code>. Stored on the lead as <code>refinanceType</code> (<code>cash_out</code> or <code>rate_term</code>).</td><td>Refinance only</td></tr><tr><td>Credit Score</td><td><code>creditScoreRange</code></td><td>Self-reported credit score range. Stored on the lead as <code>mortechCreditRating</code>. Engine always runs a soft pull.</td><td>All Mortgage Product Types</td></tr><tr><td>Date of Birth</td><td><code>dateOfBirth</code></td><td>Consumer's date of birth. Stored on the lead as <code>YYYY-MM-DD</code>.</td><td>All Mortgage Product Types</td></tr><tr><td>Phone Number</td><td><code>phoneNumber</code></td><td>Primary phone number. Stored on the lead as <code>primaryPhone</code>.</td><td>All Mortgage Product Types</td></tr><tr><td>First Name</td><td><code>firstName</code></td><td>Legal first name.</td><td>All mortgage types</td></tr><tr><td>Last Name</td><td><code>lastName</code></td><td>Legal last name.</td><td>All mortgage types</td></tr><tr><td>Email Address</td><td><code>email</code></td><td>Email address.</td><td>All mortgage types</td></tr><tr><td>Street Address</td><td><code>address1</code></td><td>Mailing street address.</td><td>All mortgage types</td></tr><tr><td>Address Line 2</td><td><code>address2</code></td><td>Apartment, unit, or suite.</td><td>Optional</td></tr><tr><td>City</td><td><code>city</code></td><td>Mailing city.</td><td>All Mortgage Product Types</td></tr><tr><td>State</td><td><code>state</code></td><td>Mailing state.</td><td>All Mortgage Product Types</td></tr><tr><td>Mailing ZIP Code</td><td><code>zipcode</code></td><td>The consumer's mailing ZIP code, collected on the Personal Information step. May differ from the property ZIP.</td><td>All Mortgage Product Types</td></tr><tr><td>Social Security Number</td><td><code>ssn</code></td><td>Collected and stored in the form <code>NNN-NN-NNNN</code>.</td><td>All Mortgage Product Types</td></tr></tbody></table>

## Client Tags for Reporting & Attribution

Engine Partner Pages support the ability to add client tags for Channel Partner Reporting, which is outlined in this section.

### How to Implement Client Tags

To add client tags to a Partner Page integration for the purpose of enhanced reporting, add query string parameters to the respective URL in the following format\*:

```
?tag.key_1=value_1&tag.key_2=value_2
```

{% hint style="info" %}
\*The first query parameter appended at the end of a URL/path should start with a question mark `?`; all subsequent parameters should start with an ampersand `&`.
{% endhint %}

Client tags are carried through the marketplace and attached to the offer search Engine creates for that consumer, which is what makes them available in your reporting.

### Sample Tag Implementation

```html
https://moneylion.com/network/{channel}/{zone}/?tag.clientId=1234&tag.source=email
```

In the above example, `clientId` and `source` are available as tags for reporting purposes.

### Supported Client Tag Keys

{% hint style="warning" %}
Client tag keys are matched exactly, including case. For example - `subid` and `subId` are stored as separate tags and will appear as separate keys in your reporting.

Please send each key with consistent casing across all requests, and use the exact spelling shown above.
{% endhint %}

Below are the client tag keys that are currently supported:

* agentId
* campaignId
* clickId
* clientId
* deviceId
* medium
* sourceId
* subId
* subId1
* subId2
* subId3
* target
* trafficsource
* userId

If a different key is needed, please reach out to your Partner Manager - we may be able to accommodate, but adding nonstandard keys will increase the time it takes Engine to report Client Tag values back to you and is therefore not recommended.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://even-financial.gitbook.io/developer-center/marketplace-integrations/partner-pages/mortgage-marketplace.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.