Skip to content

Mortgage · Calculation

Review entered Loan Estimate figures and rate lock

Screen a fully amortizing fixed-rate offer for arithmetic and entry anomalies and calculate the disclosed rate lock's remaining calendar days on a supplied date.

Open Loan Estimate Scanner · Fields in HT Calc

This HT Calc screen includes a Pro sample for visitors.

Example result · fieldReviewCount: 0 count See output

Cost per success
1 calculation credit
Production plans
Standard, Business, Scale, Enterprise
Plan allowances
Free sandbox
Not available

Integration example

Make a request

Use a production key scoped to loan-estimate-field-and-lock-review.

Keep the key on your server. A successful call uses 1 calculation credit.

Production request

Set HT_PRODUCTION_KEY on your server. Save as example.mjs and run node example.mjs with Node.js 18 or later.

import { randomUUID } from "node:crypto";

const key = process.env.HT_PRODUCTION_KEY;
if (!key) throw new Error("Set HT_PRODUCTION_KEY on your server.");
const endpoint = "https://calc.hasstechapi.com/v2/calc/loan-estimate-field-and-lock-review";
const input = {
  "product": "fully-amortizing-fixed",
  "loanAmount": 120000,
  "interestRate": 6,
  "loanTerm": 30,
  "monthlyPI": 719.46,
  "apr": 6.1,
  "grossClosingCosts": 4000,
  "totalOriginationCharges": 1050,
  "asOfDate": "2026-11-14",
  "lock": {
    "status": "locked",
    "expiryDate": "2026-11-24"
  }
};
const requestId = process.env.HT_REQUEST_ID || Date.now() + "." + randomUUID();
// Keep this ID to look up usage if the connection is interrupted.
console.error("Usage lookup ID:", requestId);

const response = await fetch(endpoint, {
  method: "POST",
  redirect: "error",
  headers: {
    "Authorization": "Bearer " + key,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId
  },
  body: JSON.stringify(input)
});
if (!response.ok) {
  const problem = await response.json().catch(() => null);
  const code = problem?.error?.code || response.statusText;
  const delay = response.headers.get("retry-after");
  if (delay) console.error("Retry-After (seconds):", delay);
  console.error("HTTP " + response.status + " " + code + ". Usage lookup ID: " + requestId);
  if (Array.isArray(problem?.error?.details)) {
    for (const issue of problem.error.details) console.error("Input issue:", JSON.stringify(issue));
  }
  process.exitCode = 1;
} else {
  console.log(JSON.stringify(await response.json(), null, 2));
}
cURL (shell)

Set HT_PRODUCTION_KEY on your server. Run in a POSIX shell with cURL 7.76+ and Python 3.7+ to create a request ID.

(
  set -eu
  : "${HT_PRODUCTION_KEY:?Set HT_PRODUCTION_KEY on your server}"
  request_id="${HT_REQUEST_ID:-}"
  if [ -z "$request_id" ]; then
    request_id=$(python3 -c 'import time, uuid; print(str(time.time_ns() // 1000000) + "." + str(uuid.uuid4()))')
  fi
  printf 'Usage lookup ID: %s\n' "$request_id" >&2
  # On INVALID_INPUT, read error.details in the JSON response body.
  curl --disable --silent --show-error --fail-with-body --include \
    --request POST 'https://calc.hasstechapi.com/v2/calc/loan-estimate-field-and-lock-review' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "product": "fully-amortizing-fixed",
  "loanAmount": 120000,
  "interestRate": 6,
  "loanTerm": 30,
  "monthlyPI": 719.46,
  "apr": 6.1,
  "grossClosingCosts": 4000,
  "totalOriginationCharges": 1050,
  "asOfDate": "2026-11-14",
  "lock": {
    "status": "locked",
    "expiryDate": "2026-11-24"
  }
}
HT_INPUT
)
If your request fails
400 INVALID_INPUT

Read error.details when present. Node prints each issue. cURL returns the JSON body. Each path points into your request. An empty path refers to the whole body.

Check the accepted inputs for required fields, units and ranges. Send the corrected JSON as a new request.

401 or 403
Check that the server has the bearer key for the endpoint’s environment and that the key includes loan-estimate-field-and-lock-review.
429
Read the service error code, check your allowance, and wait for the Retry-After interval when supplied before trying again.
Lost response, 409 or 503
Open Request lookup, select the same environment and enter the printed usage lookup ID. A settled ID has already consumed credits. To retry the same calculation, set HT_REQUEST_ID to the original ID and reuse the same inputs. A settled request does not return its result again. Unset the variable for a new request, which can consume credits.

The usage lookup ID is the Idempotency-Key your server sends. The response’s x-request-id identifies the HTTP exchange for support.

Output

Example result

These values come from running this operation on the example inputs.

fieldReviewCount
0 count
lockStatus
locked-expiring
lockDaysRemaining
10 calendar days
How to interpret this result
  • Enter gross closing costs before credits. Checks use the source's fixed-rate arithmetic and document-entry thresholds. A flagged value calls for review of the underlying figure.
  • Supply the date of review and the documented lock status. A calendar day difference does not establish the lender's expiry time or extension policy.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "fieldReviewCount": 0,
    "fieldReviews": [],
    "lockStatus": "locked-expiring",
    "lockDaysRemaining": 10
  },
  "formulaVersion": "loan-estimate-field-and-lock-review-htcalc-719df2c0e105",
  "units": {
    "fieldReviewCount": "count",
    "lockDaysRemaining": "calendar days"
  },
  "assumptions": [
    "Enter gross closing costs before credits. Checks use the source's fixed-rate arithmetic and document-entry thresholds. A flagged value calls for review of the underlying figure.",
    "Supply the date of review and the documented lock status. A calendar day difference does not establish the lender's expiry time or extension policy."
  ],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

Fields for this example. Expand the schema for all supported combinations and limits.

FieldType, units and limits

productRequired
stringMust equal "fully-amortizing-fixed"
loanAmountRequired
numberMin 0.01 · Max 100000000
interestRateRequired
numberMin 0 · Max 100
loanTermRequired
integerMin 1 · Max 40
monthlyPIRequired
numberMin 0.01 · Max 1000000
aprRequired
numberMin 0 · Max 100
grossClosingCostsRequired
numberMin 0 · Max 100000000
totalOriginationChargesRequired
numberMin 0 · Max 100000000
asOfDateRequired
stringFormat: date
lockRequired
object
lock.statusRequired
stringMust equal "locked"
lock.expiryDateRequired
stringFormat: date
Example request body (JSON)
{
  "product": "fully-amortizing-fixed",
  "loanAmount": 120000,
  "interestRate": 6,
  "loanTerm": 30,
  "monthlyPI": 719.46,
  "apr": 6.1,
  "grossClosingCosts": 4000,
  "totalOriginationCharges": 1050,
  "asOfDate": "2026-11-14",
  "lock": {
    "status": "locked",
    "expiryDate": "2026-11-24"
  }
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "product": {
      "const": "fully-amortizing-fixed"
    },
    "loanAmount": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 100000000
    },
    "interestRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100
    },
    "loanTerm": {
      "type": "integer",
      "minimum": 1,
      "maximum": 40
    },
    "monthlyPI": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000
    },
    "apr": {
      "type": "number",
      "minimum": 0,
      "maximum": 100
    },
    "grossClosingCosts": {
      "type": "number",
      "minimum": 0,
      "maximum": 100000000
    },
    "totalOriginationCharges": {
      "type": "number",
      "minimum": 0,
      "maximum": 100000000
    },
    "asOfDate": {
      "type": "string",
      "format": "date"
    },
    "lock": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "status": {
              "const": "locked"
            },
            "expiryDate": {
              "type": "string",
              "format": "date"
            }
          },
          "required": [
            "status",
            "expiryDate"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "enum": [
                "unlocked",
                "unknown"
              ]
            }
          },
          "required": [
            "status"
          ],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": [
    "product",
    "loanAmount",
    "interestRate",
    "loanTerm",
    "monthlyPI",
    "apr",
    "grossClosingCosts",
    "totalOriginationCharges",
    "asOfDate",
    "lock"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/loan-estimate-field-and-lock-review
Formula: loan-estimate-field-and-lock-review-htcalc-719df2c0e105

Related PDF reports