Mortgage Wizard (אשף המשכנתאות) API Integration & OpenBanking Services

1. Mortgage data entry capture

Mirror the step-by-step intake flow that the app uses: loan amount, property value, equity, repayment horizon, household income, and existing financial obligations. Each field maps to a typed JSON property that downstream brokers or banks can consume without re-keying. Useful for client-onboarding portals and mortgage broker CRMs.

2. Optimal mortgage mix calculator API

Expose the in-app mix optimizer as a stateless endpoint. Send the borrower profile, get back the recommended weighting across Prime, Kvua Tzmuda (fixed CPI-linked), Kvua Lo Tzmuda (fixed unlinked), and Mishtana (variable) tracks, with month-by-month amortization tables and total-interest projections.

3. Cross-bank offer comparison

Normalize bank offer matrices into a comparable schema (lender, track, nominal rate, effective rate, monthly payment, total return). Lets dashboards rank Hapoalim vs Leumi vs Mizrahi Tefahot vs Discount programmatically and feed scoring engines that pick the lower-total-return option.

4. Premium AI document decoder

Wrap the premium document-decoding service so PDF mortgage offers and existing-mortgage statements upload via a single multipart endpoint and return structured fields: principal balance, residual term, indexation, monthly payment, and effective APR.

5. Refinancing (Michzur) advisor

Run the refinance calculation against current market rates. The endpoint takes the decoded existing-mortgage object, queries today's bank offers, and returns a delta with break-even months and projected savings — usable for advisor outreach automations.

6. Webhook events & export

Deliver completion webhooks when a user finalizes a mix or uploads a new offer, and provide JSON / Excel / PDF exports for record-keeping. Fits operations teams that already work in Excel and need a hand-off bridge from the app to internal tools.

Mortgage broker workbench

An Israeli mortgage brokerage wants to import every client's calculated mix and bank offers into their internal CRM. We expose a /mashkanta/mix endpoint and a webhook that fires when the user finalizes a recommendation, then map fields to the broker's pipeline stages. Maps cleanly to OpenData principles: user-authorized export of structured records.

OpenBanking aggregator enrichment

Aggregators such as Finanda or Feezback already pull bank account data under the Bank of Israel PSD2 standard. Adding decoded mortgage offers and refinance simulations from the Mortgage Wizard rounds out the household-debt picture for budgeting clients (RiseUp-style users) without forcing them to re-key data.

Bank outreach & pricing dashboard

A lender wants to see, in near real time, how its offers stack up against competitors in the app's comparison matrix. We deliver a daily snapshot endpoint that anonymizes user-level data and returns aggregate rate distributions, useful for product-pricing teams responding to Bank of Israel rate-cycle changes.

Refinance retention campaign

Wealth advisors target clients who are paying above-market rates on existing mortgages. Using the Premium AI document decoder, advisors batch-upload offer PDFs, the API returns structured residual schedules, and the cycle endpoint flags clients with break-even windows under 24 months.

Aliyah & Olim financial onboarding

Olim and foreign buyers using sites like Bruchim Habaim or Nefesh B'Nefesh resources need a unified affordability picture. Embedding the mortgage mix and total-return endpoints into onboarding journeys gives new immigrants a clear, English-friendly view of mashkanta scenarios before meeting a banker.

Authentication: OAuth-style token exchange

POST /api/v1/mortgage-wizard/auth/token
Content-Type: application/json

{
  "client_id": "studio_partner_42",
  "client_secret": "<SECRET>",
  "user_consent_token": "<CONSENT_FROM_APP>",
  "scope": "mix.read offers.read documents.decode"
}

Response:
{
  "access_token": "ey...",
  "expires_in": 3600,
  "scope": "mix.read offers.read documents.decode",
  "user_ref": "uw_8f3c..."
}

Mortgage mix query

GET /api/v1/mortgage-wizard/mix?user_ref=uw_8f3c
Authorization: Bearer <ACCESS_TOKEN>

Response:
{
  "mix_id": "mix_2026_04_12",
  "loan_amount_ils": 1450000,
  "term_months": 300,
  "tracks": [
    {"type": "prime",          "weight": 0.33, "rate": 0.061, "monthly_ils": 3110},
    {"type": "kvua_tzmuda",    "weight": 0.33, "rate": 0.039, "monthly_ils": 2680},
    {"type": "mishtana_madad", "weight": 0.34, "rate": 0.048, "monthly_ils": 2860}
  ],
  "total_return_ils": 2470000,
  "currency": "ILS"
}

Premium document decode

POST /api/v1/mortgage-wizard/documents/decode
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: multipart/form-data

file: hapoalim_offer_2026_04.pdf
doc_type: bank_offer | existing_mortgage

Response:
{
  "doc_type": "bank_offer",
  "lender": "BankHapoalim",
  "tracks_detected": 4,
  "fields": {
    "principal_ils": 1450000,
    "term_months": 300,
    "linked_to_cpi": true,
    "effective_apr": 0.0467
  },
  "confidence": 0.94
}

Errors handled:
- 415 unsupported_media_type
- 422 ocr_low_confidence (returns partial fields + flag)

MashkantaOn (משכנתאון)

A simple Israeli mortgage calculator on Google Play. Holds entered loan parameters and computed monthly amortization. Users who switch between MashkantaOn and Mortgage Wizard often want a unified mix export that survives platform changes.

Mortgage Calculator (com.ashaf.mortgagecalc)

The companion calculator from the same studio family. Stores entered loan, term, and rate values plus calculated monthly payment, which can flow into the broader Mortgage Wizard mix optimizer through a shared schema.

Mortgage Document File Manager

An Israeli app focused on organizing mortgage documents. Holds uploaded PDFs and metadata; pairs naturally with the Mortgage Wizard premium decoder so files indexed there can be parsed into structured fields.

Ribit.io

An Israeli mortgage planning platform with algorithmic optimization and live coaching. Maintains user mortgage scenarios server-side; integration users want a normalized export across Ribit and Mortgage Wizard for portfolio-level views.

RiseUp

A leading Israeli budgeting fintech (paid tier around NIS 45/month). Holds personalized cash-flow records; users often want their Mortgage Wizard mortgage mix imported so monthly debt service is reflected accurately in cash-flow plans.

FamilyBiz

An Israeli 360° net-worth app that aggregates banks, credit cards, insurance, pensions, mortgages, and even crypto. A natural target for receiving Mortgage Wizard mix exports as the "mortgage" line in the household ledger.

Finanda

Israel's ISA-licensed financial aggregator under PSD2 / Bank of Israel Open Banking rules. Holds bank account aggregations; pairs with mortgage data so advisor dashboards see income, balance, and mortgage obligation in one feed.

Feezback

An Israeli OpenBanking specialist serving fintechs. Integration teams often combine Feezback's account streams with Mortgage Wizard outputs to build holistic affordability and refinance-eligibility models.

Wifix

An Israeli mortgage-focused platform marketing itself as a "mortgage revolution". Holds mortgage offer data and lead-handling workflows; users often request unified offer schemas covering both Wifix and Mortgage Wizard.

Buxfer (Israel)

A cross-border budget app frequently used by Olim. Holds expense and income records; benefits from a Mortgage Wizard mortgage line item so budgeting reflects Israeli mashkanta payment realities.

Deliverables checklist

• OpenAPI / Swagger specification of all endpoints (auth, mix, offers, documents, refinance)
• Protocol & auth flow report covering app token chain and consent capture
• Runnable source code (Python and Node.js reference implementations)
• Document decoding pipeline for offer PDFs and existing-mortgage statements
• Automated tests, sample data, and Postman collection
• Compliance guidance referencing Bank of Israel Open Banking and Israel Privacy Protection Law

Engagement workflow

1. Scope confirmation — pick the modules: mix, offers, documents, refinance, webhooks.
2. Protocol analysis & API design (2–5 business days, complexity-dependent).
3. Implementation and internal validation (3–8 business days).
4. Documentation, sample collection, and test cases (1–2 business days).
5. Typical first delivery: 5–15 business days; document-decoding accuracy tuning may extend timelines.

About our studio

We are an independent technical service studio specializing in App interface integration and authorized API integration. Our team has hands-on experience in mobile applications and fintech, including Israeli OpenBanking, mortgage workflows, and document-decoding pipelines. We deliver protocol analysis, interface refactoring, OpenData integration, third-party interface integration, automated data scripting, and detailed interface documentation.

• Financial and banking apps — transaction records, statement query interfaces, mortgage data flows
• Mortgage and lending platforms — offer aggregation, refinance simulators, document decoding
• OpenBanking aggregators — consent-based data extraction aligned with PSD2 and the Bank of Israel standard
• Custom Python / Node.js / Go SDKs and test harnesses
• Source code delivery from $300 — runnable API source code and full documentation; pay after delivery upon satisfaction
• Pay-per-call API billing — access our hosted API and pay only per call, no upfront cost

Contact

For quotes, sandbox access, or to submit your target app and requirements, reach us via the contact page:

Contact page

Tell us which Mortgage Wizard modules you need (mix, offers, documents, refinance) and any preferred SDK language so we can scope quickly.