PDF report
Financial Hub snapshot
Dated household balance sheet, qualifying income and obligations, rated DTI and Money Moves guidance from caller-supplied records.
Visitors can explore a sample snapshot. Saved accounts, loans and properties open within the member’s own Financial Hub.
- Cost per success
- 1 calculation credit + 1 PDF report
- Production plans
- Business, Scale, Enterprise
Plan allowances - Free sandbox
- Not available
Integration example
Request a PDF
Before your first report
- Open Widgets & reports in your paid workspace.
Save your brand name, accent and at least one exact HTTPS origin, such as
https://app.example.com. The origins identify sites allowed to embed your widgets. - Under Report credentials, name a credential, select
financial-huband choose Create report credential. Save the secret shown once in your server’sHT_REPORT_KEY. - Run the example on your server against
accounts.hasstechapi.com, without anOriginheader. A successful request returns a PDF and uses 1 calculation credit and 1 PDF report. Running the example again starts a new paid request.
What if the PDF doesn’t arrive?
For 400 INVALID_INPUT, inspect error.details when present. Paths for template fields start with input. Fix the indicated field and send a new request. This validation error uses zero credits and zero reports.
Open the .pdf.request.json file the example saved before sending. Within 24 hours, open
Request lookup in the same workspace, choose
Production, and paste the file’s requestId. The response’s X-Request-Id is a separate support identifier.
A settled request shows the calculation credits and report used. The service doesn’t keep the PDF for download. Check your saved file first. A replacement with a new ID uses 1 calculation credit and 1 PDF report on success.
If the outcome is unclear, check the workspace and ID, then look it up again before requesting a replacement.
Set HT_REPORT_KEY on your server. Save as example.mjs and run node example.mjs with Node.js 18 or later.
import { randomUUID } from "node:crypto";
import { writeFile } from "node:fs/promises";
const key = process.env.HT_REPORT_KEY;
if (!key) throw new Error("Set HT_REPORT_KEY on your server.");
const endpoint = "https://accounts.hasstechapi.com/v2/reports/financial-hub";
const input = {
"asOf": "2026-11-15",
"incomeSources": [
{
"gross_monthly_amount": 5200,
"qualifying_monthly_amount": 5000
}
],
"housing": {
"status": "own_mortgaged",
"has_escrow": true,
"total_monthly_payment": 1200,
"property_tax_monthly": 150,
"hoa_fees": 50,
"second_mortgage_payment": 50,
"current_estimated_value": 210000,
"purchase_price": 200000,
"remaining_balance": 155000
},
"properties": [
{
"is_rented": true,
"monthly_rent": 2000,
"monthly_pi": 1000,
"current_estimated_value": 160000,
"mortgage_balance": 90000
}
],
"debts": [
{
"debt_type": "credit_card",
"current_balance": 2000,
"monthly_payment": 100,
"interest_rate": 19
}
],
"assets": [
{
"type": "savings",
"value": 7000,
"asOf": "2026-11-14"
}
],
"vehicles": [
{
"estimatedValue": 10000,
"loanBalance": 12000
}
],
"businesses": [
{
"estimatedValue": 30000,
"liabilities": 10000
}
],
"accounts": [
{
"account_type": "savings",
"current_balance": 7000,
"legacyMirror": true,
"mirrorAssetIndex": 0
},
{
"account_type": "checking",
"current_balance": 1000
}
],
"creditScore": 700
};
const requestId = Date.now() + "." + randomUUID();
const output = "financial-hub-" + requestId + ".pdf";
await writeFile(output + ".request.json", JSON.stringify({ requestId, endpoint }), {
flag: "wx", mode: 0o600
});
console.error("Usage lookup ID:", requestId);
const response = await fetch(endpoint, {
method: "POST",
redirect: "error",
headers: {
"Authorization": "Bearer " + key,
"Content-Type": "application/json"
},
body: JSON.stringify({ requestId, 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 {
if (response.headers.get("content-type")?.split(";")[0] !== "application/pdf") {
throw new Error("Expected a PDF. Look up request " + requestId);
}
await writeFile(output, new Uint8Array(await response.arrayBuffer()), { flag: "wx" });
console.log("Saved", output);
} Output
PDF output
A successful request returns the PDF file as application/pdf. The example writes a file named financial-hub-<requestId>.pdf.
See the Financial Hub household snapshot calculation and example result.
Request contract
Accepted inputs
Fields for this example. Expand the schema for all supported combinations and limits.
FieldType, units and limits
asOfRequiredReal UTC calendar date, YYYY-MM-DD.
Format: date · Min length 10 · Max length 10incomeSourcesRequiredincomeSources[].gross_monthly_amountRequiredUSD per month.
Min 0 · Max 10000000000 · Step 0.01incomeSources[].qualifying_monthly_amountRequiredUSD per month.
Min 0 · Max 10000000000 · Step 0.01incomeSources[].fromAffordabilitySyncOptionaldebtsRequireddebts[].debt_typeRequireddebts[].current_balanceRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01debts[].monthly_paymentRequiredUSD per month.
Min 0 · Max 10000000000 · Step 0.01debts[].interest_rateOptionalAnnual percentage points, e.g. 6.5.
Min 0 · Max 100 · Step 0.00001debts[].months_remainingOptionaldebts[].is_excluded_from_dtiOptionaldebts[].will_pay_offOptionaldebts[].imputed_payment_amountOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01debts[].fromAffordabilitySyncOptionaldebts[].balance_kindOptionaldebts[].freshnessOptionaldebts[].requires_refreshOptionalassetsRequiredassets[].typeRequiredassets[].valueRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01assets[].asOfOptionalReal UTC calendar date, YYYY-MM-DD.
Format: date · Min length 10 · Max length 10propertiesRequiredproperties[].purchase_priceOptionalUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01properties[].current_estimated_valueRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01properties[].mortgage_balanceRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01properties[].is_rentedOptionalproperties[].monthly_rentOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01properties[].qualifying_rental_incomeOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01properties[].monthly_piOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01properties[].second_mortgage_paymentOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01properties[].property_tax_monthlyOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01properties[].insurance_monthlyOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01properties[].hoa_feesOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housingOptionalhousing.statusRequiredhousing.has_escrowOptionalhousing.principal_interestOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.second_mortgage_paymentOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.property_tax_monthlyOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.home_insurance_monthlyOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.hoa_feesOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.pmiOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.monthly_rentOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.total_monthly_paymentOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.purchase_priceOptionalUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01housing.current_estimated_valueOptionalUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01housing.remaining_balanceOptionalUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01housing.interest_rateOptionalAnnual percentage points, e.g. 6.5.
Min 0 · Max 100 · Step 0.00001housing.mortgage_balance_kindOptionalhousing.mortgage_balance_freshnessOptionalaccountsOptionalaccounts[].account_typeRequiredaccounts[].current_balanceRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01accounts[].archivedOptionalaccounts[].legacyMirrorOptionalaccounts[].mirrorAssetIndexOptionalZero-based index of the matching asset, if a compatibility shadow.
Min 0 · Max 99accounts[].projectionOptionalaccounts[].projection.valueRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01accounts[].projection.observedRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01accounts[].projection.observationKindRequiredaccounts[].projection.projectedRequiredaccounts[].projection.currentRequiredvehiclesOptionalvehicles[].estimatedValueRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01vehicles[].loanBalanceRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01businessesOptionalbusinesses[].estimatedValueRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01businesses[].liabilitiesRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01legacyIncomeOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01legacyDebtOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01creditScoreOptionalUser-entered score or selected band estimate; omit if unknown.
Min 300 · Max 850creditIsEstimateOptionalactiveGoalsOptionalconventionalRateOptionalOptional caller-supplied conventional rate (% per year) for the 36% and 43% affordability estimates; no feed is contacted.
Min 0 · Max 100 · Step 0.00001Example input (JSON)
The server example adds a fresh requestId to this input.
{
"input": {
"asOf": "2026-11-15",
"incomeSources": [
{
"gross_monthly_amount": 5200,
"qualifying_monthly_amount": 5000
}
],
"housing": {
"status": "own_mortgaged",
"has_escrow": true,
"total_monthly_payment": 1200,
"property_tax_monthly": 150,
"hoa_fees": 50,
"second_mortgage_payment": 50,
"current_estimated_value": 210000,
"purchase_price": 200000,
"remaining_balance": 155000
},
"properties": [
{
"is_rented": true,
"monthly_rent": 2000,
"monthly_pi": 1000,
"current_estimated_value": 160000,
"mortgage_balance": 90000
}
],
"debts": [
{
"debt_type": "credit_card",
"current_balance": 2000,
"monthly_payment": 100,
"interest_rate": 19
}
],
"assets": [
{
"type": "savings",
"value": 7000,
"asOf": "2026-11-14"
}
],
"vehicles": [
{
"estimatedValue": 10000,
"loanBalance": 12000
}
],
"businesses": [
{
"estimatedValue": 30000,
"liabilities": 10000
}
],
"accounts": [
{
"account_type": "savings",
"current_balance": 7000,
"legacyMirror": true,
"mirrorAssetIndex": 0
},
{
"account_type": "checking",
"current_balance": 1000
}
],
"creditScore": 700
}
} Full JSON schema
{
"type": "object",
"properties": {
"asOf": {
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10,
"pattern": "^(19|20|21)[0-9]{2}-[0-9]{2}-[0-9]{2}$",
"description": "Real UTC calendar date, YYYY-MM-DD."
},
"incomeSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"gross_monthly_amount": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"qualifying_monthly_amount": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"fromAffordabilitySync": {
"type": "boolean"
}
},
"required": [
"gross_monthly_amount",
"qualifying_monthly_amount"
],
"additionalProperties": false
},
"maxItems": 100
},
"debts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"debt_type": {
"type": "string",
"enum": [
"auto",
"student",
"credit_card",
"personal",
"medical",
"collections",
"mortgage",
"heloc",
"other"
]
},
"current_balance": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"monthly_payment": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"interest_rate": {
"type": "number",
"minimum": 0,
"maximum": 100,
"multipleOf": 0.00001,
"description": "Annual percentage points, e.g. 6.5."
},
"months_remaining": {
"type": "integer",
"minimum": 0,
"maximum": 600
},
"is_excluded_from_dti": {
"type": "boolean"
},
"will_pay_off": {
"type": "boolean"
},
"imputed_payment_amount": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"fromAffordabilitySync": {
"type": "boolean"
},
"balance_kind": {
"type": "string",
"enum": [
"verified",
"projected",
"missing"
]
},
"freshness": {
"type": "string",
"enum": [
"current",
"refresh_recommended",
"incomplete"
]
},
"requires_refresh": {
"type": "boolean"
}
},
"required": [
"debt_type",
"current_balance",
"monthly_payment"
],
"additionalProperties": false
},
"maxItems": 100
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"cash",
"savings",
"investment_brokerage",
"investment_retirement",
"crypto",
"vehicle",
"other"
]
},
"value": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"asOf": {
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10,
"pattern": "^(19|20|21)[0-9]{2}-[0-9]{2}-[0-9]{2}$",
"description": "Real UTC calendar date, YYYY-MM-DD."
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
"maxItems": 100
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"purchase_price": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"current_estimated_value": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"mortgage_balance": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"is_rented": {
"type": "boolean"
},
"monthly_rent": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"qualifying_rental_income": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"monthly_pi": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"second_mortgage_payment": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"property_tax_monthly": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"insurance_monthly": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"hoa_fees": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
}
},
"required": [
"current_estimated_value",
"mortgage_balance"
],
"additionalProperties": false
},
"maxItems": 100
},
"housing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"rent",
"live_with_family",
"own_free_clear",
"own_mortgaged"
]
},
"has_escrow": {
"type": "boolean"
},
"principal_interest": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"second_mortgage_payment": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"property_tax_monthly": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"home_insurance_monthly": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"hoa_fees": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"pmi": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"monthly_rent": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"total_monthly_payment": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"purchase_price": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"current_estimated_value": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"remaining_balance": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"interest_rate": {
"type": "number",
"minimum": 0,
"maximum": 100,
"multipleOf": 0.00001,
"description": "Annual percentage points, e.g. 6.5."
},
"mortgage_balance_kind": {
"type": "string",
"enum": [
"verified",
"projected",
"missing"
]
},
"mortgage_balance_freshness": {
"type": "string",
"enum": [
"current",
"refresh_recommended",
"incomplete"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"accounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_type": {
"type": "string",
"enum": [
"checking",
"savings",
"cash",
"credit_card",
"mortgage",
"auto_loan",
"student_loan",
"personal_loan",
"loan",
"investment",
"retirement",
"heloc",
"home_equity_loan",
"money_market",
"cd",
"crypto",
"property",
"vehicle",
"collectible",
"business_interest",
"other"
]
},
"current_balance": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"archived": {
"type": "boolean"
},
"legacyMirror": {
"type": "boolean"
},
"mirrorAssetIndex": {
"type": "integer",
"minimum": 0,
"maximum": 99,
"description": "Zero-based index of the matching asset, if a compatibility shadow."
},
"projection": {
"type": "object",
"properties": {
"value": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"observed": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"observationKind": {
"type": "string",
"enum": [
"verified",
"estimated"
]
},
"projected": {
"type": "boolean"
},
"current": {
"type": "boolean"
}
},
"required": [
"value",
"observed",
"observationKind",
"projected",
"current"
],
"additionalProperties": false
}
},
"required": [
"account_type",
"current_balance"
],
"additionalProperties": false
},
"maxItems": 100
},
"vehicles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"estimatedValue": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"loanBalance": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
}
},
"required": [
"estimatedValue",
"loanBalance"
],
"additionalProperties": false
},
"maxItems": 100
},
"businesses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"estimatedValue": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"liabilities": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
}
},
"required": [
"estimatedValue",
"liabilities"
],
"additionalProperties": false
},
"maxItems": 100
},
"legacyIncome": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"legacyDebt": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"creditScore": {
"type": "integer",
"minimum": 300,
"maximum": 850,
"description": "User-entered score or selected band estimate; omit if unknown."
},
"creditIsEstimate": {
"type": "boolean"
},
"activeGoals": {
"type": "array",
"items": {
"type": "string",
"enum": [
"home_loan_optimization",
"debt_payoff_consistency",
"net_worth_stability"
]
},
"maxItems": 3,
"uniqueItems": true
},
"conventionalRate": {
"type": "number",
"minimum": 0,
"maximum": 100,
"multipleOf": 0.00001,
"description": "Optional caller-supplied conventional rate (% per year) for the 36% and 43% affordability estimates; no feed is contacted."
}
},
"required": [
"asOf",
"incomeSources",
"debts",
"assets",
"properties"
],
"additionalProperties": false
}Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/financial-hub
Formula: financial-hub-profile-snapshot-1.0.0 · Report version: 1.0.0