Skip to content
Docs

HELOC Inquiries/Offers

Get direct debt payoff offers

GET/products/heloc/v1/inquiry/{appUuid}/direct-debt-payoff-offers
API key required
Request
curl -X GET \
  "https://api.test.figure.com/products/heloc/v1/inquiry/{appUuid}/direct-debt-payoff-offers" \
  -H "apikey: $FIGURE_API_KEY"

Path parameters

  • appUuidstringRequired

Query parameters

  • accountIdarray of strings

Responses

200OKobject

  • dataobjectRequired
    ShowHide 3 attributes of data
    • organizationstringRequired
    • appUuidstring<uuid>Required
    • offersarray of objectsRequired
      ShowHide 11 attributes of offers
      • uuidstring<uuid>Required
      • minAmountnumberRequired
      • maxAmountnumberRequired
      • ratenumberRequired
      • primeRatenumberRequired
      • terminteger<int32>Required
      • rateTypeenumRequired
        One ofUNKNOWNFIXEDVARIABLE
      • originationFeePercentnumberRequired
      • discountsarray of objects
        ShowHide 2 attributes of discounts
        • typestringRequired
        • rateDiscountAmountnumberRequired
      • preDiscountOriginationFeenumber
      • appliedOriginationFeeCapAmountnumber
  • messagesarray of objects
    ShowHide 2 attributes of messages
    • levelstringRequired
    • messagestringRequired
Response
{
  "data": {
    "organization": "string",
    "appUuid": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
    "offers": [
      {
        "uuid": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
        "minAmount": 0,
        "maxAmount": 0,
        "rate": 0,
        "primeRate": 0,
        "term": 0,
        "rateType": "UNKNOWN",
        "originationFeePercent": 0,
        "discounts": [
          {
            "type": "string",
            "rateDiscountAmount": 0
          }
        ],
        "preDiscountOriginationFee": 0,
        "appliedOriginationFeeCapAmount": 0
      }
    ]
  },
  "messages": [
    {
      "level": "string",
      "message": "string"
    }
  ]
}