LeedWallet · HELOC lead post
Field reference
The 31 fields LeedWallet posts to your endpoint for each HELOC lead: name, type, allowed values and format.
Buying DSCR leads too? DSCR posts a different set of fields. See the DSCR field reference.
- Fields31
- MethodHTTP POST
- Body
application/json - ValuesJSON strings
1Overview
How a lead gets from LeedWallet into your system, in order.
- Provide your endpointGive LeedWallet the URL that will receive HELOC leads and any authentication header it requires. This is configured at onboarding, separately from any DSCR delivery.
- Accept the postEach lead arrives as one HTTP POST with a JSON body of 31 fields. Every value is a string. See section 2.
- Map the fieldsMatch each field to your system using the tables in section 5. Convert numeric and yes/no values, and the coded list values, on your side.
- Store the consent fieldsKeep
tcpa_text,ip_address,user_agent,jornayaandtrustedFormCertUrlwith the lead record. See section 5.6. - Confirm receiptReturn a 2xx HTTP status. Use
transaction_idto reject duplicates.
2Delivery format
Transport and formatting rules that apply to every field in the post.
- Transport
- One HTTP POST per lead with a JSON body (
Content-Type: application/json). Endpoint URL and any authentication headers are configured per buyer at onboarding. - Field presence
- All 31 fields are present on every post. A field that does not apply to the lead is sent as an empty string, not
nulland not omitted. - Value types
- Every value is sent as a JSON string, including numeric fields. Numbers contain no currency symbols or thousands separators. Yes/no fields contain the lowercase strings
yesorno, not booleans. Some list values are codes, such assole_ownerandfull_time; map them to your own labels. - Field names
- Field names are case-sensitive. All are snake_case except
trustedFormCertUrl. - Timestamp
- The HELOC post carries no submission timestamp. Record the time you receive it.
- Response
- Return a 2xx HTTP status to confirm receipt.
- Duplicate handling
transaction_idis unique per lead. Use it for duplicate checks.
3Field types
Type labels used in section 5, as defined by the LeedWallet delivery platform.
| Type | Meaning |
|---|---|
| Text | Free-form string. Most are short; user_agent and tcpa_text can exceed several hundred characters. |
| Email address, format-validated at submission. | |
| Phone | 10-digit US number. |
| State | Two-letter USPS abbreviation. |
| Postal code | Five-digit ZIP. Keep it as text so leading zeros survive. |
| IP address | IPv4 dotted quad, e.g. 203.0.113.42. Store as text. |
| Numeric | Digits with an optional decimal point (123, 12.34). No symbols or separators. Sent as a string. |
| List | One of the allowed values, spelled and cased as shown. |
4Conditional fields
2 fieldsTwo fields carry a value only when existing_mortgage has a specific value. Otherwise they arrive as an empty string. Fields not listed here are not tied to another field's value.
| When | These fields are populated | Otherwise |
|---|---|---|
existing_mortgage is one or two | remaining_mortgage_primary | Empty when existing_mortgage is none. |
existing_mortgage is two | remaining_mortgage_secondary | Empty when existing_mortgage is none or one. |
5Fields
25 underwriting · 6 consent & deliverySix groups. Field names are exactly as posted. List fields contain one of the values shown; all other types show an example value. Fields whose value depends on another field are listed in section 4.
5.1Borrower contact
9 fieldsBorrower name, contact details and the property address.
| Field | Type & format | Description |
|---|---|---|
first_ | Text ExampleDana | Borrower's first name. |
last_ | Text ExampleWhitfield | Borrower's last name. |
email | Email Exampledana.whitfield@example.com | Borrower's email address. Format-validated at submission. |
mobile | Phone Example(614) 555-0187 | Borrower's mobile number, 10-digit US. Remove formatting if your system stores digits only. |
date_ | Text Example04/18/1971 | Borrower's date of birth as entered, MM/DD/YYYY. May be empty. |
address | Text Example2217 Linden Ave | Street address of the property as entered on the form. |
city | Text ExampleColumbus | City as entered on the form. |
state | State ExampleOH | Two-letter USPS abbreviation (CA, NY, FL). |
zip_ | Postal code Example43209 | Five-digit ZIP. Store as text to preserve leading zeros. |
5.2Loan request
3 fieldsLine amount, what the funds are for, and the credit band.
| Field | Type & format | Description |
|---|---|---|
loan_ | Numeric Example75000 | Requested line amount in USD. Digits only, no currency symbol or commas. |
loan_ | List Allowed values
| What the borrower plans to use the funds for. |
credit_ | List Allowed values
| Credit band as reported by the borrower, not a credit pull. Delivered leads are Fair (640+) or better; Poor is listed for schema completeness. These bands differ from the DSCR bands. |
5.3Property
5 fieldsThe home the line would be secured by.
| Field | Type & format | Description |
|---|---|---|
property_ | List Allowed values
| How the borrower uses the property. |
property_ | List Allowed values
| Property type as selected on the form. |
estimated_ | Numeric Example420000 | Borrower's estimate of the property's current value in USD. |
ownership_ | List Allowed values
| How title is held: by the borrower alone, jointly, or through a trust or entity. |
property_ | List Allowed values
| Whether the property is currently listed for sale. |
5.4Existing mortgages
3 fieldsLiens on the property today. With estimated_property_value they give you equity and CLTV.
| Field | Type & format | Description |
|---|---|---|
existing_ | List Allowed values
| Number of mortgages currently on the property. |
remaining_ | Numeric Example185000 | Balance on the first mortgage in USD. Empty when existing_mortgage is none. |
remaining_ | Numeric Example40000 | Balance on the second mortgage in USD. Empty unless existing_mortgage is two. |
5.5Income & background
5 fieldsIncome, employment and credit history as reported by the borrower.
| Field | Type & format | Description |
|---|---|---|
annual_ | Numeric Example96000 | Borrower's annual income in USD as reported. |
employment_ | List Allowed values
| Borrower's employment status. |
proof_ | List Allowed values
| How the borrower would document income. May be empty. |
active_ | List Allowed values
| Whether the borrower is on active military duty. |
bankruptcy | List Allowed values
| Whether the borrower reports a bankruptcy. |
5.6Consent, compliance & delivery
6 fieldsConsent records and identifiers for the lead.
| Field | Type & format | Description |
|---|---|---|
tcpa_ | Text ExampleBy clicking Submit, I agree to receive calls and text messages from LeedWallet and up to three lending partners at the number provided, including via automated dialing technology. Consent is not a condition of purchase. | The exact consent language the borrower agreed to at submission. Store with the lead record. |
ip_ | IP address Example203.0.113.42 | Borrower's IP address at submission. |
user_ | Text ExampleMozilla/5.0 (iPhone; CPU iPhone OS 17_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.5 Mobile/15E148 Safari/604.1 | Browser user-agent string captured at submission. |
jornaya | Text Example3f2a9c1e-7b4d-4e8a-9f01-2c6d5b8a1e47 | Jornaya LeadiD token for independent consent verification. |
trustedFormCertUrl | Text Examplehttps:/ | TrustedForm certificate URL. Note the camelCase name, which differs from the DSCR post. Retain it in your TrustedForm account promptly; unclaimed certificates expire. |
transaction_ | Text Example8c41f2e7-9a3b-4d6e-b5c0-72f1a9e3d4b8 | LeedWallet's unique ID for the lead. Use it for duplicate checks and when referencing the lead with LeedWallet. |
No field matches that search.
6Sample post
Example valuesExample values only: one existing mortgage, so remaining_mortgage_secondary is empty.
{ "first_name": "Dana", "last_name": "Whitfield", "email": "dana.whitfield@example.com", "mobile": "(614) 555-0187", "date_of_birth": "04/18/1971", "address": "2217 Linden Ave", "city": "Columbus", "state": "OH", "zip_code": "43209", "loan_amount": "75000", "loan_reason": "Home improvement", "credit_score": "Good (680-719)", "property_use": "Primary", "property_type": "Single Family", "estimated_property_value": "420000", "ownership_type": "joint_owner", "property_for_sale": "no", "existing_mortgage": "one", "remaining_mortgage_primary": "185000", "remaining_mortgage_secondary": "", "annual_income": "96000", "employment_status": "full_time", "proof_of_income": "tax_returns", "active_military": "no", "bankruptcy": "no", "tcpa_text": "By clicking Submit, I agree to receive calls and text messages from LeedWallet and up to three lending partners at the number provided, including via automated dialing technology. Consent is not a condition of purchase.", "ip_address": "203.0.113.42", "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.5 Mobile/15E148 Safari/604.1", "jornaya": "3f2a9c1e-7b4d-4e8a-9f01-2c6d5b8a1e47", "trustedFormCertUrl": "https://cert.trustedform.com/6f1c0a9e2b7d4c3a8e5f1b2d9c0a7e6f4d3b2a10", "transaction_id": "8c41f2e7-9a3b-4d6e-b5c0-72f1a9e3d4b8"}
The borrower, property, tokens and consent text above are placeholders and do not describe a real lead.