SDK Quick Start — Banking & Financial Services

Getting started: Banking & Financial Services

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. Use this vocabulary to describe workflows such as payment fraud screening, loan underwriting, customer onboarding, and model validation. Select fields that your integration can report reliably. Your compliance team must determine which requirements apply; recording a field does not satisfy those requirements.

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: "banking.payment.rail", policyInput: "banking_payment_rail", value: "fednow" },
    { attribute: "banking.payment.agent_action", policyInput: "banking_payment_agent_action", value: "initiate_credit_transfer" },
    { attribute: "banking.sanctions.screening_outcome", policyInput: "banking_sanctions_screening_outcome", value: "clear" },
  ];

  // Policy runs before action() and again before the result is released.
  // A deny or review decision means action() never runs.
  return veriproof.govern(
    "banking.financial.services.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 Banking & Financial Services 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 { PaymentRailType, PaymentRailTypeMeta, PaymentAgentActionType, PaymentAgentActionTypeMeta, SanctionsScreeningOutcome, SanctionsScreeningOutcomeMeta } from '@veriproof/sdk-core/industries/banking-financial-services';

// Replace sample values with facts from the current workflow.
// Each value becomes one policy field and one evidence attribute.
const industry = [
  Industry.fact(PaymentRailTypeMeta, PaymentRailType.Fednow),
  Industry.fact(PaymentAgentActionTypeMeta, PaymentAgentActionType.InitiateCreditTransfer),
  Industry.fact(SanctionsScreeningOutcomeMeta, SanctionsScreeningOutcome.Clear),
];

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

Python

from veriproof_sdk.verticals.banking_financial_services import PaymentRailType, PaymentAgentActionType, SanctionsScreeningOutcome

# Replace sample values with facts from the current workflow.
# Each value becomes one policy field and one evidence attribute.
industry = (
    PaymentRailType.fednow.fact(),
    PaymentAgentActionType.initiate_credit_transfer.fact(),
    SanctionsScreeningOutcome.clear.fact(),
)

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

.NET

using Veriproof.Sdk.Core.Industries.BankingFinancialServices;

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

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

Workflow examples from the catalog

• Payments & Funds Transfer: Payment Rail Type. OPA rule: require enhanced OFAC/sanctions screening for swift_cbpr_plus, sepa_credit_transfer, and sepa_instant rails. Require 24/7 HITL coverage for fednow and rtp_tcf rails above configurable threshold. (Fednow: Federal Reserve FedNow Service Operating Procedures)
• Payments & Funds Transfer: Payment Agent Action Type. OPA rule: classify initiate_credit_transfer, initiate_direct_debit, and apply_fx_conversion as irreversible_high_impact, requiring HITL approval above configurable amount threshold. (Psd2: PSD2 Article 64, Liability for unauthorized payment transactions)
• Payments & Funds Transfer: Sanctions Screening Outcome. OPA rule: deny any payment agent tool call for payment rail execution when sanctions_screening_outcome is potential_hit or confirmed_hit; require HITL escalation. (Ofac: OFAC 31 CFR Part 501, Reporting and procedures for blocked transactions)
• Fraud Detection & Financial Crime: AMLAlert Status. OPA rule: require HITL with compliance_officer role for sar_decision_pending state. Block automated sar_filed or sar_declined_documented transitions, these must be human-authorised. (Bsa 31 Usc 5318: BSA 31 USC 5318(g), Suspicious Activity Report filing obligation)

Next steps

• Open the full Banking & Financial Services governance reference for all 36 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.