SDK Quick Start — Mortgage & Loan Processing

Getting started: Mortgage & Loan Processing

Control what your AI can do. The core SDK checks policy before your workflow runs an action and again before its result is released. Denied actions stop. Actions that need human review stay paused until a signed outcome arrives.

Catalog context. Start with one workflow, such as document extraction or underwriting review. Record the source documents, decision context, and review outcome your integration can supply. Check reporting values against the receiving system's current specification. This catalog is not a substitute for the required submission format or a compliance review.

Use industry fields with the core SDK

Industry vocabularies supply typed values that the SDK sends as policy fields and evidence attributes with one governed call. Choose values that describe the actual workflow. Adding a vocabulary does not activate rules or assign regulatory requirements.

If you need the cross-industry baseline first, open the core SDK reference, Python core, or .NET core before continuing here.

Step 1 — Install the approved packages

In the customer portal, open Tools and SDKs. Select your language and adapters, then follow the installation instructions shown there.

VeriProof SDKs are distributed through customer-gated GitLab packages, not public registries. See SDK access for workstation and CI guidance.

VeriProof packages used here: @veriproof/sdk-core (TypeScript), veriproof-sdk (Python), Veriproof.Sdk.Core (.NET).

Step 2 — Configure

Store the application SDK key as VERIPROOF_API_KEY and create one client when the application starts. Publish the policy you want to enforce, then confirm its field contract against the facts and industry values your application supplies.

Copy the application ID and key from Set up SDK. The application ID is not its display name. Try a live demo  to see a governed workflow, or request an evaluation  if you need a workspace.

Step 3 — Govern the action

Put the protected business action inside govern. The SDK checks policy before it calls the action and before it releases the result. Deny and human-review decisions stop execution here.

import { Veriproof } from '@veriproof/sdk-core';
import type { GovernedResult, IndustryFact, JsonValue } from '@veriproof/sdk-core';

const veriproof = Veriproof.fromEnv();

export async function runProtectedAction<TInput extends JsonValue, TValue>(
  request: TInput,
  action: (input: TInput, signal: AbortSignal) => Promise<TValue>,
): Promise<GovernedResult<TValue, TInput>> {
  // Catalog values for this vertical. Replace them with facts from the current workflow.
  const industry: IndustryFact[] = [
    { attribute: "mortgage.application.status", policyInput: "mortgage_application_status", value: "prequalification_inquiry" },
  ];

  // Policy runs before action() and again before the result is released.
  // A deny or review decision means action() never runs.
  return veriproof.govern(
    "mortgage.loan.processing.evaluate",
    request,
    ({ input, signal }) => action(input, signal),
    { industry },
  );
}

Only completed, completed_with_warning, and transformed results carry a released value. Handle every other status with its safe message, reason code, and evidence reference. For review decisions, save the checkpoint and continue through the human review workflow.

Add typed industry values

Each core SDK ships this vertical's vocabulary as generated types. A typed value becomes one policy field and one evidence attribute when you pass it to the governed call. Use application facts for values that are specific to your workflow.

Find this workflow's vocabulary in the Mortgage & Loan Processing reference. Use the attribute names below and verify their policy-field mapping before using them in a rule. Sample values show the format; they are not recommended outcomes for your application.

TypeScript

import { Industry } from '@veriproof/sdk-core';
import { MortgageApplicationStatus, MortgageApplicationStatusMeta } from '@veriproof/sdk-core/industries/mortgage-loan-processing';

// Replace sample values with facts from the current workflow.
// Each value becomes one policy field and one evidence attribute.
const industry = [
  Industry.fact(MortgageApplicationStatusMeta, MortgageApplicationStatus.PrequalificationInquiry),
];

const result = await veriproof.govern(actionName, request, runWorkflow, { industry });

Python

from veriproof_sdk.verticals.mortgage_loan_processing import MortgageApplicationStatus

# Replace sample values with facts from the current workflow.
# Each value becomes one policy field and one evidence attribute.
industry = (
    MortgageApplicationStatus.prequalification_inquiry.fact(),
)

result = await vp.govern(action_name, request, run_workflow, industry=industry)

.NET

using Veriproof.Sdk.Core.Industries.MortgageLoanProcessing;

// Replace sample values with facts from the current workflow.
// Each value becomes one policy field and one evidence attribute.
var options = new GovernOptions
{
    Industry =
    [
        MortgageApplicationStatus.PrequalificationInquiry.Fact(),
    ],
};

var result = await veriproof.GovernAsync(actionName, request, RunWorkflowAsync, options);

Workflow examples from the catalog

• Automated Underwriting System (AUS): AUSRecommendation. Route a Refer with Caution result to an underwriter before issuing a commitment. This illustrative control stops automated approval while the lender checks whether manual underwriting is permitted for the loan. (Fnma Selling Guide: Fannie Mae Selling Guide B3-2, Desktop Underwriter)
• TRID Disclosure Management: TRIDDisclosure Status. Illustrative policy: stop automated closing while the applicable disclosure waiting period remains open. Check receipt dates and correction triggers, not status alone. Send claimed emergency waivers for review. (Trid Reg Z 1026 19f: 12 CFR 1026.19(f), Closing Disclosure receipt generally at least three business days before consummation)
• Loss Mitigation & Default Management: Loss Mitigation Option Type. Hold an automated foreclosure referral when applicable loss-mitigation protections restrict the action. Check application completeness, receipt dates, foreclosure stage, and appeal status. An illustrative lender rule can require compliance review before release. (Reg X 1024 41: Regulation X 12 CFR 1024.41, Loss-mitigation review and foreclosure restrictions depend on application timing, completeness, and the foreclosure stage)
• Regulatory Reporting: Adverse Action Notice Status. Keep notice work open when a required adverse-action notice is missing, overdue, or incomplete. Route it to the responsible reviewer. This illustrative archival control complements the lender's notice deadlines and record-retention rules. (Ecoa Reg B 1002 9: Reg B 12 CFR 1002.9, Notification of action taken, ECOA notice, and statement of specific reasons)

Next steps

• Open the full Mortgage & Loan Processing governance reference for all 34 enum categories, policy patterns, and source standards.
• Review TypeScript SDK core for stop handling, human review continuation, and the OpenAI Agents adapter.
• Review Python SDK core for stop handling, human review continuation, and the Microsoft Agent Framework adapter.
• Review .NET SDK core for stop handling, human review continuation, and the Microsoft Agent Framework adapter.
• Browse all vertical references to understand how the core governance vocabulary layers underneath vertical-specific attribute sets.
• Compare this guide with the public industry pages  for a business overview of the same workflows.