# Finpace Developer Portal ## Docs - [Agent UI](https://docs.finpace.tech/ai/agent-ui.md): White-label AI interaction layer for customers and staff. - [AI runtime overview](https://docs.finpace.tech/ai/ai-runtime-overview.md): How Finpace embeds AI into banking safely. - [AI Shield](https://docs.finpace.tech/ai/ai-shield.md): Policy, risk, and perimeter controls for partner and agent interactions. - [Governed actions and approval controls](https://docs.finpace.tech/ai/governed-actions-and-approval-controls.md): How AI-assisted actions are evaluated, staged, and executed. - [MCP gateway](https://docs.finpace.tech/ai/mcp-gateway.md): Perimeter abstraction for AI and partner access. - [Model governance and audit](https://docs.finpace.tech/ai/model-governance-and-audit.md): AI evidence, explainability, retention, and operational governance. - [Create account application](https://docs.finpace.tech/api-reference/accounts/create-account-application.md) - [Create account arrangement](https://docs.finpace.tech/api-reference/accounts/create-account-arrangement.md): Open arrangement from product and customer context. - [Create direct debit mandate](https://docs.finpace.tech/api-reference/accounts/create-direct-debit-mandate.md) - [Create signatory](https://docs.finpace.tech/api-reference/accounts/create-signatory.md) - [Create standing order](https://docs.finpace.tech/api-reference/accounts/create-standing-order.md) - [Get account application](https://docs.finpace.tech/api-reference/accounts/get-account-application.md) - [Get account arrangement](https://docs.finpace.tech/api-reference/accounts/get-account-arrangement.md) - [List account applications](https://docs.finpace.tech/api-reference/accounts/list-account-applications.md) - [List accounts](https://docs.finpace.tech/api-reference/accounts/list-accounts.md) - [List direct debit mandates](https://docs.finpace.tech/api-reference/accounts/list-direct-debit-mandates.md) - [List signatories](https://docs.finpace.tech/api-reference/accounts/list-signatories.md) - [List standing orders](https://docs.finpace.tech/api-reference/accounts/list-standing-orders.md) - [Create customer agreement](https://docs.finpace.tech/api-reference/agreements/create-customer-agreement.md): Create agreement across account, loan, overdraft, or service. - [Get customer agreement](https://docs.finpace.tech/api-reference/agreements/get-customer-agreement.md) - [List customer agreements](https://docs.finpace.tech/api-reference/agreements/list-customer-agreements.md) - [Create AI assist session](https://docs.finpace.tech/api-reference/ai-runtime/create-ai-assist-session.md): Create governed AI session. - [Evaluate AI policy](https://docs.finpace.tech/api-reference/ai-runtime/evaluate-ai-policy.md): Evaluate policy for requested tool or action. - [Execute governed AI tool](https://docs.finpace.tech/api-reference/ai-runtime/execute-governed-ai-tool.md): Execute policy-approved AI tool. - [List AI assist sessions](https://docs.finpace.tech/api-reference/ai-runtime/list-ai-assist-sessions.md) - [List AI audit events](https://docs.finpace.tech/api-reference/ai-runtime/list-ai-audit-events.md) - [List AI session messages](https://docs.finpace.tech/api-reference/ai-runtime/list-ai-session-messages.md) - [Send AI session message](https://docs.finpace.tech/api-reference/ai-runtime/send-ai-session-message.md) - [Create posting instruction](https://docs.finpace.tech/api-reference/balances/create-posting-instruction.md) - [Get balances](https://docs.finpace.tech/api-reference/balances/get-balances.md) - [Get posting instruction](https://docs.finpace.tech/api-reference/balances/get-posting-instruction.md) - [List fee runs](https://docs.finpace.tech/api-reference/balances/list-fee-runs.md) - [List interest runs](https://docs.finpace.tech/api-reference/balances/list-interest-runs.md) - [List posting instructions](https://docs.finpace.tech/api-reference/balances/list-posting-instructions.md) - [List transactions](https://docs.finpace.tech/api-reference/balances/list-transactions.md) - [Create campaign](https://docs.finpace.tech/api-reference/campaigns/create-campaign.md): Create campaign with targeting and approval metadata. - [Create experiment](https://docs.finpace.tech/api-reference/campaigns/create-experiment.md): Create controlled A/B experiment for product, pricing, or messaging. - [Get campaign](https://docs.finpace.tech/api-reference/campaigns/get-campaign.md) - [Get experiment](https://docs.finpace.tech/api-reference/campaigns/get-experiment.md) - [List campaigns](https://docs.finpace.tech/api-reference/campaigns/list-campaigns.md) - [List experiment assignments](https://docs.finpace.tech/api-reference/campaigns/list-experiment-assignments.md) - [List experiment variants](https://docs.finpace.tech/api-reference/campaigns/list-experiment-variants.md) - [List experiments](https://docs.finpace.tech/api-reference/campaigns/list-experiments.md) - [Create case](https://docs.finpace.tech/api-reference/cases/create-case.md): Create service, dispute, or operational case. - [Create task for case](https://docs.finpace.tech/api-reference/cases/create-task-for-case.md) - [Get case](https://docs.finpace.tech/api-reference/cases/get-case.md) - [List cases](https://docs.finpace.tech/api-reference/cases/list-cases.md) - [List tasks for case](https://docs.finpace.tech/api-reference/cases/list-tasks-for-case.md) - [Create availability window](https://docs.finpace.tech/api-reference/channels/create-availability-window.md) - [Create channel feature flag](https://docs.finpace.tech/api-reference/channels/create-channel-feature-flag.md) - [Create channel session](https://docs.finpace.tech/api-reference/channels/create-channel-session.md): Create omnichannel session context. - [Get channel session](https://docs.finpace.tech/api-reference/channels/get-channel-session.md) - [List channel availability windows](https://docs.finpace.tech/api-reference/channels/list-channel-availability-windows.md) - [List channel feature flags](https://docs.finpace.tech/api-reference/channels/list-channel-feature-flags.md) - [List channel sessions](https://docs.finpace.tech/api-reference/channels/list-channel-sessions.md) - [Create collateral](https://docs.finpace.tech/api-reference/collateral/create-collateral.md): Create collateral record with owner and valuation context. - [Create collateral link](https://docs.finpace.tech/api-reference/collateral/create-collateral-link.md) - [Create condition precedent](https://docs.finpace.tech/api-reference/collateral/create-condition-precedent.md) - [Create covenant](https://docs.finpace.tech/api-reference/collateral/create-covenant.md): Create covenant with thresholds and monitoring rules. - [Create covenant breach](https://docs.finpace.tech/api-reference/collateral/create-covenant-breach.md) - [Get collateral](https://docs.finpace.tech/api-reference/collateral/get-collateral.md) - [List collateral links](https://docs.finpace.tech/api-reference/collateral/list-collateral-links.md) - [List collateral records](https://docs.finpace.tech/api-reference/collateral/list-collateral-records.md) - [List conditions precedent](https://docs.finpace.tech/api-reference/collateral/list-conditions-precedent.md) - [List covenant breaches](https://docs.finpace.tech/api-reference/collateral/list-covenant-breaches.md) - [List covenants](https://docs.finpace.tech/api-reference/collateral/list-covenants.md) - [Waive covenant breach](https://docs.finpace.tech/api-reference/collateral/waive-covenant-breach.md) - [Create customer](https://docs.finpace.tech/api-reference/customers/create-customer.md): Create customer from party and segment attributes. - [Get customer](https://docs.finpace.tech/api-reference/customers/get-customer.md) - [List customer consents](https://docs.finpace.tech/api-reference/customers/list-customer-consents.md) - [List customers](https://docs.finpace.tech/api-reference/customers/list-customers.md) - [Create document](https://docs.finpace.tech/api-reference/documents/create-document.md): Register uploaded or generated document. - [Get document](https://docs.finpace.tech/api-reference/documents/get-document.md) - [List documents](https://docs.finpace.tech/api-reference/documents/list-documents.md) - [Create entitlement](https://docs.finpace.tech/api-reference/entitlements/create-entitlement.md): Create action-level entitlement. - [Get entitlement](https://docs.finpace.tech/api-reference/entitlements/get-entitlement.md) - [List entitlements](https://docs.finpace.tech/api-reference/entitlements/list-entitlements.md) - [Create event subscription](https://docs.finpace.tech/api-reference/events/create-event-subscription.md): Subscribe to business events. - [List event subscriptions](https://docs.finpace.tech/api-reference/events/list-event-subscriptions.md) - [Create interaction event](https://docs.finpace.tech/api-reference/interactions/create-interaction-event.md): Write inbound or outbound interaction evidence. - [Create routing profile](https://docs.finpace.tech/api-reference/interactions/create-routing-profile.md): Create contact-center or RM routing profile. - [Get customer workbench context](https://docs.finpace.tech/api-reference/interactions/get-customer-workbench-context.md) - [Get interaction event](https://docs.finpace.tech/api-reference/interactions/get-interaction-event.md) - [Get routing profile](https://docs.finpace.tech/api-reference/interactions/get-routing-profile.md) - [List interaction events](https://docs.finpace.tech/api-reference/interactions/list-interaction-events.md) - [List routing profiles](https://docs.finpace.tech/api-reference/interactions/list-routing-profiles.md) - [Create affordability assessment](https://docs.finpace.tech/api-reference/lending/create-affordability-assessment.md): Run or persist affordability assessment. - [Create credit application](https://docs.finpace.tech/api-reference/lending/create-credit-application.md): Create SME or consumer lending application. - [Create decision package](https://docs.finpace.tech/api-reference/lending/create-decision-package.md): Create decision package from scoring, bureau, and policy results. - [Create drawdown](https://docs.finpace.tech/api-reference/lending/create-drawdown.md) - [Create extra payment request](https://docs.finpace.tech/api-reference/lending/create-extra-payment-request.md) - [Create facility](https://docs.finpace.tech/api-reference/lending/create-facility.md): Create facility after accepted offer. - [Create forbearance action](https://docs.finpace.tech/api-reference/lending/create-forbearance-action.md) - [Create payment holiday](https://docs.finpace.tech/api-reference/lending/create-payment-holiday.md) - [Create reschedule](https://docs.finpace.tech/api-reference/lending/create-reschedule.md) - [Generate credit offer](https://docs.finpace.tech/api-reference/lending/generate-credit-offer.md) - [Get affordability assessment](https://docs.finpace.tech/api-reference/lending/get-affordability-assessment.md) - [Get credit application](https://docs.finpace.tech/api-reference/lending/get-credit-application.md) - [Get decision package](https://docs.finpace.tech/api-reference/lending/get-decision-package.md) - [Get facility](https://docs.finpace.tech/api-reference/lending/get-facility.md) - [List affordability assessments](https://docs.finpace.tech/api-reference/lending/list-affordability-assessments.md) - [List credit applications](https://docs.finpace.tech/api-reference/lending/list-credit-applications.md) - [List decision packages](https://docs.finpace.tech/api-reference/lending/list-decision-packages.md) - [List drawdowns](https://docs.finpace.tech/api-reference/lending/list-drawdowns.md) - [List facilities](https://docs.finpace.tech/api-reference/lending/list-facilities.md) - [List forbearance actions](https://docs.finpace.tech/api-reference/lending/list-forbearance-actions.md) - [List payment holidays](https://docs.finpace.tech/api-reference/lending/list-payment-holidays.md) - [List reschedules](https://docs.finpace.tech/api-reference/lending/list-reschedules.md) - [Receive decision callback](https://docs.finpace.tech/api-reference/lending/receive-decision-callback.md) - [Record decision for credit application](https://docs.finpace.tech/api-reference/lending/record-decision-for-credit-application.md) - [Submit credit application](https://docs.finpace.tech/api-reference/lending/submit-credit-application.md) - [Add liquidity pool member](https://docs.finpace.tech/api-reference/liquidity/add-liquidity-pool-member.md) - [Create liquidity pool](https://docs.finpace.tech/api-reference/liquidity/create-liquidity-pool.md): Create notional or physical liquidity pool. - [Create sweep instruction](https://docs.finpace.tech/api-reference/liquidity/create-sweep-instruction.md): Create target-balancing or sweep instruction. - [Get liquidity pool](https://docs.finpace.tech/api-reference/liquidity/get-liquidity-pool.md) - [Get sweep instruction](https://docs.finpace.tech/api-reference/liquidity/get-sweep-instruction.md) - [List liquidity pool members](https://docs.finpace.tech/api-reference/liquidity/list-liquidity-pool-members.md) - [List liquidity pools](https://docs.finpace.tech/api-reference/liquidity/list-liquidity-pools.md) - [List sweep instructions](https://docs.finpace.tech/api-reference/liquidity/list-sweep-instructions.md) - [Create notification delivery](https://docs.finpace.tech/api-reference/notifications/create-notification-delivery.md) - [Create notification template](https://docs.finpace.tech/api-reference/notifications/create-notification-template.md): Create template with channel, language, and approval workflow. - [Create statement request](https://docs.finpace.tech/api-reference/notifications/create-statement-request.md) - [Get notification template](https://docs.finpace.tech/api-reference/notifications/get-notification-template.md) - [List notification deliveries](https://docs.finpace.tech/api-reference/notifications/list-notification-deliveries.md) - [List notification templates](https://docs.finpace.tech/api-reference/notifications/list-notification-templates.md) - [List statements](https://docs.finpace.tech/api-reference/notifications/list-statements.md) - [Health check](https://docs.finpace.tech/api-reference/operations/health-check.md) - [Create party](https://docs.finpace.tech/api-reference/parties/create-party.md): Create a natural person or legal entity record. - [Create party group](https://docs.finpace.tech/api-reference/parties/create-party-group.md) - [Get party](https://docs.finpace.tech/api-reference/parties/get-party.md) - [List parties](https://docs.finpace.tech/api-reference/parties/list-parties.md) - [List party groups](https://docs.finpace.tech/api-reference/parties/list-party-groups.md) - [Approve payment](https://docs.finpace.tech/api-reference/payments/approve-payment.md) - [Create payment](https://docs.finpace.tech/api-reference/payments/create-payment.md): Initiate payment with mandate and limit checks. - [Get payment](https://docs.finpace.tech/api-reference/payments/get-payment.md) - [List payments](https://docs.finpace.tech/api-reference/payments/list-payments.md) - [Reject payment](https://docs.finpace.tech/api-reference/payments/reject-payment.md) - [Create pricing quotation](https://docs.finpace.tech/api-reference/pricing/create-pricing-quotation.md) - [Create rate card](https://docs.finpace.tech/api-reference/pricing/create-rate-card.md): Create risk-, channel-, and campaign-aware rate card. - [Get rate card](https://docs.finpace.tech/api-reference/pricing/get-rate-card.md) - [List pricing quotations](https://docs.finpace.tech/api-reference/pricing/list-pricing-quotations.md) - [List rate cards](https://docs.finpace.tech/api-reference/pricing/list-rate-cards.md) - [Create product](https://docs.finpace.tech/api-reference/products/create-product.md): Create versioned product template. - [Create product bundle](https://docs.finpace.tech/api-reference/products/create-product-bundle.md) - [Create product offer](https://docs.finpace.tech/api-reference/products/create-product-offer.md): Create commercial offer tied to pricing and eligibility. - [Get product](https://docs.finpace.tech/api-reference/products/get-product.md) - [List product bundles](https://docs.finpace.tech/api-reference/products/list-product-bundles.md) - [List product offers](https://docs.finpace.tech/api-reference/products/list-product-offers.md) - [List product versions](https://docs.finpace.tech/api-reference/products/list-product-versions.md) - [List products](https://docs.finpace.tech/api-reference/products/list-products.md) - [Accounts, arrangements, and mandates](https://docs.finpace.tech/domains/accounts-arrangements-and-mandates.md): Arrangements, balances, signatories, mandates, and lifecycle controls. - [Affordability, scoring, and decisioning](https://docs.finpace.tech/domains/affordability-scoring-and-decisioning.md): Responsible-lending checks, score orchestration, pricing inputs, and asynchronous decisions. - [Cases, documents, and tasks](https://docs.finpace.tech/domains/cases-documents-and-tasks.md): Operational work management and document lifecycle. - [Collateral, covenants, and conditions](https://docs.finpace.tech/domains/collateral-covenants-and-conditions.md): Collateral records, covenant monitoring, conditions precedent, and waiver control. - [Customer interaction and channels](https://docs.finpace.tech/domains/customer-interaction-and-channels.md): Omnichannel access, sessions, channel control, and assisted service. - [Lending origination](https://docs.finpace.tech/domains/lending-origination.md): Applications, data collection, offers, approvals, and contract creation. - [Lending servicing](https://docs.finpace.tech/domains/lending-servicing.md): Drawdowns, repayments, restructures, forbearance, and servicing events. - [Notifications, statements, and correspondence](https://docs.finpace.tech/domains/notifications-statements-and-correspondence.md): Outbound communication, templates, delivery events, and statement generation. - [Party and customer model](https://docs.finpace.tech/domains/party-and-customer-model.md): Party, customer, legal entity, relationship, and consent design. - [Payments, limits, and liquidity](https://docs.finpace.tech/domains/payments-limits-and-liquidity.md): Payments, approvals, limits, liquidity pools, sweeps, and balance events. - [Postings, balances, and ledger](https://docs.finpace.tech/domains/postings-balances-and-ledger.md): Posting instructions, holds, balances, accounting, and reconciliation model. - [Pricing, campaigns, and experimentation](https://docs.finpace.tech/domains/pricing-campaigns-and-experimentation.md): Rate cards, offer pricing, campaign orchestration, and controlled experimentation. - [Product factory and offers](https://docs.finpace.tech/domains/product-factory-and-offers.md): How products, versions, bundles, pricing, and offers are modeled. - [Relationship workbench and interaction history](https://docs.finpace.tech/domains/relationship-workbench-and-interaction-history.md): RM workbench, contact-center context, routing, and interaction evidence. - [API conventions](https://docs.finpace.tech/getting-started/api-conventions.md): Authentication, idempotency, approvals, events, and error patterns. - [Platform architecture](https://docs.finpace.tech/getting-started/platform-architecture.md): Reference architecture for Finpace core banking, channels, integrations, and governed AI runtime. - [Platform capabilities](https://docs.finpace.tech/getting-started/platform-capabilities.md): Capability scope for the Finpace platform. - [Security and governance](https://docs.finpace.tech/getting-started/security-and-governance.md): Security, role controls, approvals, encryption, and audit expectations. - [Consumer lending](https://docs.finpace.tech/guides/consumer-lending.md): Reference guide for personal loan origination and servicing. - [Retail and business account launch](https://docs.finpace.tech/guides/retail-and-business-account-launch.md): Reference guide for deposit and overdraft launch patterns. - [SME lending](https://docs.finpace.tech/guides/sme-lending.md): Reference guide for SME term loans and credit lines. - [SME onboarding and account opening](https://docs.finpace.tech/guides/sme-onboarding-and-account-opening.md): End-to-end guide for assisted and digital SME onboarding. - [Overview](https://docs.finpace.tech/index.md): Finpace core banking, lending, servicing, workflow, and governed AI runtime documentation. - [Reference overview](https://docs.finpace.tech/reference/overview.md): What the Finpace API covers and how to read it. ## OpenAPI Specs - [openapi](https://docs.finpace.tech/openapi.yaml) - [1openapi](https://docs.finpace.tech/1openapi.yaml) ## Optional - [Finpace website](https://www.finpace.tech) - [Halcyon](https://www.finpace.tech/halcyon) - [Contact](https://www.finpace.tech/contact)