DOCUMENTATION HUB
  • Welcome
  • Platform
    • Platform Overview
    • Partners & Sites
    • Lender Hub Pipeline View
    • Landing Pages
    • Loan Assignment Links
    • Loan Officer Pages
    • Borrower Tasks
    • Borrower Document Uploads
    • Milestones
    • Troubleshooting Encompass eDisclosure packages
    • Testing Procedures
    • Blueprints
    • Sagas
      • Saga Methods Reference
    • Pushback Endpoints
    • Third Party Integrations
      • Credit Providers
        • CBC / Factual Data
        • Meridian Link
        • CoreLogic - CredCo
        • Informative Research
      • Loan Origination Systems (LOS)
        • BytePro
        • MortgageFlex
        • MeridianLink Mortgage
        • Encompass
      • Verification of Assets (VOA)
        • AccountChek by FormFree
        • Finicity
      • Verification of Employment/Income (VOIE)
        • The Work Number
      • Pricing Engines
        • Optimal Blue
        • Mortech
        • EPPS
        • PriceMyLoan
        • Polly
      • Payment Vendors
        • Celero Commerce (formerly Transnational)
      • AUS
        • Desktop Underwriter (DU)
        • Loan Product Advisor (LPA)
      • eSign
        • Dropbox Sign (formerly HelloSign)
        • DocuSign
        • EllieDocs
      • Fees
        • SmartFees
      • Customer Relationship Management (CRM)
        • SalesForce
        • TotalExpert
        • Velocify
      • Private Mortgage Insurance
    • Single Sign-On (SSO)
    • UI/UX Customizations
    • DNS Setup
    • Email White Labeling Setup
    • Notifications
    • Analytics
    • Pre-Qualification Letter
    • Teamwork
    • Reset Password
    • Webhooks
  • Encompass e-Disclosure Integration
  • Create Applications from Encompass Loans
  • Access Level Management
  • Lender Hub User Management
  • Reports Tab
  • API
    • API Overview
    • API Playground
  • Release Notes
    • Release Notes Overview
    • 2025 Release Notes
      • May 7th, 2025 Release Notes
      • April 9th, 2025 Release Notes
      • March 5th, 2025 Release Notes
      • February 5, 2025 Release Notes
      • January 8, 2025 Release Notes
    • 2024 Release Notes
      • December 4, 2024 Release Notes
      • November 6, 2024 Release Notes
      • October 10, New Feature Release: Task Due Dates & Notifications
      • October 2, 2024 Release Notes
      • September 4, 2024 Release Notes
      • August 7, 2024 Release Notes
      • July 10, 2024 Release Notes
      • June 5, 2024 Release Notes
      • May 1, 2024 Release Notes
      • April 3, 2024 Release Notes
      • March 11, 2024 Release Notes
      • February 6, 2024 Release Notes
      • January 24, 2024 Release Notes
      • January 10, 2024 Release Notes
    • 2023 Release Notes
      • December 27, 2023 Release Notes
      • December 12, 2023 Release Notes
      • November 29, 2023 Release Notes
      • November 15, 2023 Release Notes
      • November 1, 2023 Release Notes
      • October 17, 2023 Release Notes
      • September 27, 2023 Release Notes
      • September 6, 2023 Release Notes
      • August 16, 2023 Release Notes
      • August 15, 2023 Release Notes
      • July 27, 2023 Release Notes
      • June 27, 2023 Release Notes
      • June 7, 2023 Release Notes
      • May 17, 2023 Release Notes
      • April 25, 2023 Release Notes
      • April 4, 2023 Release Notes
      • March 15, 2023 Release Note
      • February 21, 2023 Release Notes
      • January 31, 2023 Release Notes
      • January 4, 2023 Release Notes
    • 2022 Release Notes
      • December 7, 2022 Release Notes
      • November 15, 2022 Release Notes
      • November 1, 2022 Release Notes
      • October 4, 2022 Release Notes
      • September 13, 2022 Release Notes
      • August 31, 2022 Release Notes
      • August 2, 2022 Release Notes
      • July 13, 2022 Release Notes
      • June 22, 2022 Release Notes
      • June 1, 2022 Release Notes
      • May 10, 2022 Release Notes
      • Apr 19, 2022 Release Notes
      • Mar 29, 2022 Release Notes
      • Mar 8, 2022 Release Notes
      • Feb 15, 2022 Release Notes
      • Jan 25, 2022 Release Notes
      • Jan 5, 2022 Release Notes
    • 2021 Release Notes
      • Dec 21, 2021 Release Notes
      • Nov 22, 2021 Release Notes
      • Nov 2, 2021 Release Notes
      • Oct 12, 2021 Release Notes
      • Sep 22, 2021 Release Notes
      • Aug 24, 2021 Release Notes
      • Aug 4, 2021 Release Notes
      • Jun 22, 2021 Release Notes
      • May 28, 2021 Release Notes
      • May 12, 2021 Release Notes
      • Apr 13, 2021 Release Notes
      • Mar 23, 2021 Release Notes
      • Feb 26, 2021 Release Notes
      • Feb 9, 2021 Release Notes
    • 2020 Release Notes
      • Dec 1, 2020 Release Notes
      • Nov 10, 2020 Release Notes
      • Oct 20, 2020 Release Notes
      • Sep 28, 2020 Release Notes
      • Sep 13, 2020 Release Notes
      • Aug 17, 2020 Release Notes
      • Jul 30, 2020 Release Notes
      • Jul 13, 2020 Release Notes
      • May 28, 2020 Release Notes
      • May 5, 2020 Release Notes
  • Client Resources
    • Client Resources Overview
    • Third Party Integrations Overview
    • Maxwell Onboarding Overview
    • Support Portal Quick Reference
    • Lender Hub User Management
    • Duplication of Applications
  • Broker Origination System (BOS)
    • Borrower Tasks in the Lender Hub
    • Exporting Client Documents from the Lender Hub
    • Exporting the MISMO 3.4 from the Lender Hub
    • Reset Password
  • Maxwell Business Intelligence
    • Data Dictionary
Powered by GitBook
On this page
  • What is a Blueprint?
  • Blueprint Editor
  • Example Blueprint JSON
  1. Platform

Blueprints

High flexibility with no code

PreviousTesting ProceduresNextSagas

Last updated 1 year ago

What is a Blueprint?

A blueprint is a set of instructions in JSON format, which create the entire Borrower journey and question flow. With the universal flexibility of blueprints, we can create any imaginable application flow for multiple financial industries.

Each under a partner can have its own blueprint, so under one hood you may run multiple sites with very different logic and application flows.

A blueprint determines:

  • What tasks are open, locked or hidden for the borrower,

  • The logic that determines what questions and input fields are displayed based on previous answers,

  • Which to run when a task is completed,

  • What custom data validations to run for each field.

Blueprint Editor

As the complexity of an application flow increases, so does the blueprint JSON structure. For that reason, we have hidden that complexity behind a powerful Blueprint Editor UI. For the time-being the Blueprint Editor is only available to our internal implementations team.

Example Blueprint JSON

Below is a small snapshot of an example blueprint.

// Tasks
[
  {
    // This is a task that our protypical task depends on
    "key": "this_is_task_1",
  },
  {
    // This is a task that our protypical task depends on
    "key": "this_is_task_2",
  },
  {
    // This is a task that our protypical task depends on
    "key": "this_is_task_3",
  },
  {
    // This is a protypical task a single task
    "key": "this_is_how_other_tasks_refer_to_this_task",
    "type": "this_is_an_enumerable_type (QuestionTask, InformationTask, etc.)",
    "meta": {
      "title": "This is the Task's Name in the Database",
      "description": {
        "default": "This is the description of the Task",
        "locked": "This is the description of the Task when locked",
        "open": "This is the description of the Task when open",
      },
    },
    "data": {},
    "transitions": [
      {
        "target_state": "open",
        "condition_statement": {
          {
            "or" : [
              {
                "and" : [
                  { "var" : "task1" },
                  { "var" : "task2" }
                ]
              },
              {
                "and" : [
                  { "var" : "task3" },
                  { "var" : "field1" }
                ]
              },
            ]
          }
        },
        "condition_vars": {
          "task1": "$task.this_is_task_1",
          "task2": "$task.this_is_task_2",
          "task3": "$task.this_is_task_3",
          "field1": "$field.transaction_is_purchase",
        }
      }
    ]
  },
  {
    // This would Represent a single Task
  },
]



// ignore this
transitions: {
  "open": {
    "conditions": [
      conditional
    ]
  }
}
var rules =
{
  "and" : [{
    "<" : [ { "var" : "temp" }, 110 ]
  }, {
    "==" : [ { "var" : "pie.filling" }, "apple" ]
  }]
};
site
sagas