Home Loan API

Overview of the specific loan product: Home Loans or Mortgages

---

Mortgages:

To search for home loans, you should set productTypes to ["Home_Loan"] on the product type parameter. To get the best matching offers, you should specify the following fields stated in Collecting User Information.

---

Consult a {home_loan}

GET /consultHomeLoan

This endpoint connects the user and their wrapped information in ID's to our Loan network. The response provides a pre-defined match to a loan that our providers have configured. The loan can be considered pre-approved and offered to the user through our embedded widget or in your native app.

Headers

Name	Value
API Key	Bearer <token>
API Secret	Bearer <token>

Body

Name	Type	Description
customerID	string	Unique identifier for the user
riskID	string	Unique identifier for the User's most recent risk score
productType	text	"Home_Loan"

Body:

{  
  "customerID": 3f020d62-6cef-4f2c-87ed-b096abc5cac9,
  "riskID": 3f020d62-6cef-4f2c-87ed-b096abc5cac9,
    {
      "productTypes": [
      "Home_Loan"
  ],
}

Response:

200

{
  "uuid": "2c6cb6e4-0aa2-4ab5-9109-8679de537e10",
  "leadUuid": "f823a7c0-586a-4fc3-9cfa-c38694b80b2c",
  "loanOffers": [],
  "specialOffers": [],
  "savingsOffers": [],
  "creditCardOffers": [],
  "mortgageOffers": [
    {
      "uuid": "fef16e91-960f-4ac7-a8ec-98d7a6b32c7e",
      "originator": {
        "key": "lending-club",
        "name": "LendingClub",
        "description": "Low fixed rate home loans from $100,000 to $750,000",
        "images": [
          {
            "sizeKey": "150",
            "url": "examplelendingclub.com"
          }
        ],
        "disclaimer": "Suspendisse rhoncus magna erat, nec rhoncus leo elementum eget."
      },
      "originatorId": null,
      "termLength": 36,
      "termUnit": "month",
      "maxAmount": 12000,
      "minAmount": 800,
      "maxApr": 35.99,
      "minApr": 25.01,
      "meanApr": 30.5,
      "feeRate": null,
      "maxFeeRate": null,
      "minFeeRate": null,
      "feeFixed": null,
      "maxFeeFixed": null,
      "minFeeFixed": null,
      "allowPrepayment": true,
      "prepaymentFee": 0,
      "monthlyPayment": 119.3,
      "maxMonthlyPayment": 137.4,
      "minMonthlyPayment": 119.3,
      "meanMonthlyPayment": 128.18,
      "maxTotalPayment": 4947,
      "minTotalPayment": 4295,
      "meanTotalPayment": 4615,
      "terms": null,
      "url": "https://offers.example.com/ref/fef16e91-960f-4ac7-a8ec-98d7a6b32c7e",
      "preQualified": false,
      "preApproved": true,
      "sponsored": false,
      "aprType": "fixed",
      "recommendationScore": 95,
      "amountPrefix": null
    },
    }
  ]
}

400

{
  "error": "Invalid request"
}