# Perflo Neobank

> Launch your own branded neobank on Perflo's money rail.

## Docs

- [Accounts](https://docs.neobank.proofof.tech/api-reference/accounts/accounts.md)
- [Activity](https://docs.neobank.proofof.tech/api-reference/activity/activity.md)
- [Beneficiaries](https://docs.neobank.proofof.tech/api-reference/beneficiaries/beneficiaries.md)
- [Beneficiary Countries](https://docs.neobank.proofof.tech/api-reference/beneficiaries/beneficiary-countries.md)
- [Beneficiary Schemas](https://docs.neobank.proofof.tech/api-reference/beneficiaries/beneficiary-schemas.md)
- [Create Beneficiary](https://docs.neobank.proofof.tech/api-reference/beneficiaries/create-beneficiary.md)
- [Get Beneficiary](https://docs.neobank.proofof.tech/api-reference/beneficiaries/get-beneficiary.md)
- [Card Reveal Session](https://docs.neobank.proofof.tech/api-reference/cards/card-reveal-session.md)
- [Card Transactions](https://docs.neobank.proofof.tech/api-reference/cards/card-transactions.md)
- [Cards](https://docs.neobank.proofof.tech/api-reference/cards/cards.md)
- [Close Card](https://docs.neobank.proofof.tech/api-reference/cards/close-card.md)
- [Create Card](https://docs.neobank.proofof.tech/api-reference/cards/create-card.md)
- [Freeze Card](https://docs.neobank.proofof.tech/api-reference/cards/freeze-card.md)
- [Unfreeze Card](https://docs.neobank.proofof.tech/api-reference/cards/unfreeze-card.md)
- [Create Confirmation Intent](https://docs.neobank.proofof.tech/api-reference/identity/create-confirmation-intent.md)
- [Get Session](https://docs.neobank.proofof.tech/api-reference/identity/get-session.md)
- [Logout](https://docs.neobank.proofof.tech/api-reference/identity/logout.md)
- [Public Config](https://docs.neobank.proofof.tech/api-reference/identity/public-config.md)
- [Create Kyc Session](https://docs.neobank.proofof.tech/api-reference/kyc/create-kyc-session.md)
- [Kyc Status](https://docs.neobank.proofof.tech/api-reference/kyc/kyc-status.md)
- [Create Mandate](https://docs.neobank.proofof.tech/api-reference/mandates/create-mandate.md)
- [Execute Mandate](https://docs.neobank.proofof.tech/api-reference/mandates/execute-mandate.md)
- [Mandates](https://docs.neobank.proofof.tech/api-reference/mandates/mandates.md)
- [Revoke Mandate](https://docs.neobank.proofof.tech/api-reference/mandates/revoke-mandate.md)
- [Disconnect Perflo Connection](https://docs.neobank.proofof.tech/api-reference/onboarding/disconnect-perflo-connection.md)
- [Onboarding](https://docs.neobank.proofof.tech/api-reference/onboarding/onboarding.md)
- [Poll Perflo Connection](https://docs.neobank.proofof.tech/api-reference/onboarding/poll-perflo-connection.md)
- [Start Perflo Connection](https://docs.neobank.proofof.tech/api-reference/onboarding/start-perflo-connection.md)
- [Get Operation](https://docs.neobank.proofof.tech/api-reference/operations/get-operation.md)
- [List Operations](https://docs.neobank.proofof.tech/api-reference/operations/list-operations.md)
- [Poll Operation Approval](https://docs.neobank.proofof.tech/api-reference/operations/poll-operation-approval.md)
- [Ops Audit](https://docs.neobank.proofof.tech/api-reference/operator/ops-audit.md)
- [Ops Mandates](https://docs.neobank.proofof.tech/api-reference/operator/ops-mandates.md)
- [Ops Operations](https://docs.neobank.proofof.tech/api-reference/operator/ops-operations.md)
- [Ops Suspend Mandate](https://docs.neobank.proofof.tech/api-reference/operator/ops-suspend-mandate.md)
- [Create Quote](https://docs.neobank.proofof.tech/api-reference/transfers/create-quote.md)
- [Create Transfer](https://docs.neobank.proofof.tech/api-reference/transfers/create-transfer.md)
- [Adapters](https://docs.neobank.proofof.tech/architecture/adapters.md): Choose the deterministic fake adapter or the production-capable live adapter.
- [Identity model](https://docs.neobank.proofof.tech/architecture/identity.md): Auth0 backend-for-frontend sessions for customers and operators, and scoped OAuth2 bearer tokens for agents.
- [Architecture](https://docs.neobank.proofof.tech/architecture/overview.md): Understand the neobank API, transactional worker, provider boundary, and customer application.
- [State and provider ledger](https://docs.neobank.proofof.tech/architecture/state-and-ledger.md): Separate local workflow and policy state from Perflo money and transaction evidence.
- [CI & review lanes](https://docs.neobank.proofof.tech/contributing/ci-and-reviews.md): The make ci gate, the integration and end-to-end suites, the three independent review lanes, and the platform invariants every change must respect.
- [License](https://docs.neobank.proofof.tech/contributing/license.md): The Perflo neobank platform is released under the Apache License 2.0 and what that means for users and partners.
- [Contribute](https://docs.neobank.proofof.tech/contributing/setup.md): Set up a local development environment for the Perflo neobank platform with the locked toolchain and a single command.
- [Branding & theming](https://docs.neobank.proofof.tech/customize/branding.md): Configure the runtime product name and mark, then customize build-time colors and typography.
- [Provider-driven currencies](https://docs.neobank.proofof.tech/customize/currencies.md): Understand how live accounts, beneficiaries, estimates, and mandate limits choose currencies.
- [Perflo hosted origins](https://docs.neobank.proofof.tech/customize/perflo-origins.md): Live mode pins the five reviewed Perflo service origins and validates hosted app URLs at every browser boundary.
- [Configure a dedicated Auth0 tenant](https://docs.neobank.proofof.tech/deploy/auth0.md): Create Management API credentials, review the tenant plan, reconcile Auth0, and deploy the generated runtime credentials.
- [Single-server deployment](https://docs.neobank.proofof.tech/deploy/dedicated-server.md): Deploy the live adapter behind Caddy with Auth0, PostgreSQL, Redis, and TLS-enabled Vault.
- [Kubernetes deployment](https://docs.neobank.proofof.tech/deploy/kubernetes.md): Configure the Helm chart for the production live adapter and its required services and secrets.
- [Local development stack](https://docs.neobank.proofof.tech/deploy/local-development.md): Run the deterministic Perflo Neobank sandbox with isolated session and task transport, loopback-only ports, and debug authentication.
- [PostgreSQL & Redis](https://docs.neobank.proofof.tech/deploy/postgres-redis.md): Provision PostgreSQL 17 and separate Redis authorities for sessions and asynchronous tasks.
- [Prerequisites](https://docs.neobank.proofof.tech/deploy/prerequisites.md): Install the toolchain and prepare identity, data, encryption, and provider access for a neobank deployment.
- [TLS and origins](https://docs.neobank.proofof.tech/deploy/tls-origins.md): Enforce exact application, Perflo, and Vault origins in live and production runtimes.
- [Vault](https://docs.neobank.proofof.tech/deploy/vault.md): Encrypt customer Perflo sessions and provider action context with the derived Transit key.
- [Production readiness](https://docs.neobank.proofof.tech/get-started/production-readiness.md): Validate the live runtime, controlled canary, security, load, backup, restore, deployment, CI, and independent reviews.
- [Quickstart](https://docs.neobank.proofof.tech/get-started/quickstart.md): Start the deterministic fake neobank and inspect its customer and operator flows.
- [Perflo Neobank](https://docs.neobank.proofof.tech/index.md): Deploy a customer-facing neobank over Perflo with asynchronous operations, browser-approved payments, and strict data minimization.
- [Agent mandates](https://docs.neobank.proofof.tech/integrate/agent-mandates.md): Approve a Perflo recipient grant and bind autonomous payments to clients, rules, United States dollar limits, and expiry.
- [Authentication](https://docs.neobank.proofof.tech/integrate/authentication.md): Authenticate customer and operator browser sessions, scoped agents, and local debug callers.
- [Confirmation and idempotency](https://docs.neobank.proofof.tech/integrate/confirmation-idempotency.md): Bind customer confirmation to a payload, replay operations safely, and handle uncertain provider writes.
- [Polling and webhooks](https://docs.neobank.proofof.tech/integrate/webhooks.md): Poll customer operations now and treat signed Perflo webhooks as a future reconciliation signal.
- [Audit](https://docs.neobank.proofof.tech/operate/audit.md): GET /v1/ops/audit returns AuditEvent rows with full actor attribution. Every financial mutation and sensitive action writes one.
- [Backups & recovery](https://docs.neobank.proofof.tech/operate/backups-recovery.md): Vault, PostgreSQL, Redis, and Caddy certificates live in named volumes. Back up vault-data, vault-bootstrap, and postgres-data together, and never run --volumes against an active connection.
- [Health & metrics](https://docs.neobank.proofof.tech/operate/health-metrics.md): Liveness and readiness probes, Prometheus metrics, rate limits, and the security headers attached to every response.
- [Operator console](https://docs.neobank.proofof.tech/operate/operator-console.md): Operators are view-and-suspend only. They authenticate through a separate Auth0 client with MFA and reach a dedicated set of /v1/ops/* routes.
- [Operator-required cleanup](https://docs.neobank.proofof.tech/operate/operator-required-cleanup.md): Resolve every device, grant, and operation tied to a quarantined Perflo binding before clearing the connection.
- [pnpm monorepo and modular monolith](https://docs.neobank.proofof.tech/reference/adrs/0001-pnpm-monorepo-and-modular-monolith.md): Repository and deployment boundaries for the first production version — a pnpm workspace and a Python modular monolith.
- [Canonical neobank API over Perflo adapters](https://docs.neobank.proofof.tech/reference/adrs/0002-canonical-neobank-api-over-perflo-adapters.md): Provider-neutral models and typed adapters isolate the public API from Perflo's four OpenAPI surfaces.
- [Auth0 BFF and approved OAuth clients](https://docs.neobank.proofof.tech/reference/adrs/0003-auth0-bff-and-approved-client-oauth.md): Customer, operator, and agent authentication via Auth0 BFF sessions, approved OAuth clients, and one-use confirmation intents.
- [Perflo credential bridge and production grant gate](https://docs.neobank.proofof.tech/reference/adrs/0004-perflo-credential-bridge-and-production-grant-gate.md): The Perflo credential bridge is temporary and non-production; production requires a scoped partner adapter.
- [Idempotent financial intents and reconciliation](https://docs.neobank.proofof.tech/reference/adrs/0005-idempotent-financial-intents-and-reconciliation.md): Financial and card mutations persist as idempotent intents before provider submission, with at-least-once delivery and indeterminate reconciliation.
- [Fine-grained autonomous mandates](https://docs.neobank.proofof.tech/reference/adrs/0006-fine-grained-autonomous-mandates.md): Autonomous execution is bound to mandates with explicit beneficiary, amount, frequency, lifetime, purpose, and caller constraints.
- [Perflo as money ledger and local operational state](https://docs.neobank.proofof.tech/reference/adrs/0007-perflo-as-money-ledger-and-local-operational-state.md): Perflo remains the money ledger; the wrapper stores only local projections and durable coordination state.
- [Customer and operations frontend](https://docs.neobank.proofof.tech/reference/adrs/0008-customer-and-operations-frontend.md): One React application serves customer banking flows and restricted operator console routes, with no offline caching.
- [Kubernetes, Vault, and observability](https://docs.neobank.proofof.tech/reference/adrs/0009-kubernetes-vault-and-observability.md): Production runs on Kubernetes with externally operated PostgreSQL, Redis, and Vault, default-deny networking, and OpenTelemetry observability.
- [Neobank-owned Perflo login for the live demo](https://docs.neobank.proofof.tech/reference/adrs/0010-neobank-owned-perflo-login-for-the-live-demo.md): The live demo links a real Perflo account through a neobank-owned device login, never reusing CLI credentials.
- [Single-origin Caddy edge for the dedicated demo](https://docs.neobank.proofof.tech/reference/adrs/0011-single-origin-caddy-edge-for-the-dedicated-demo.md): The dedicated demo serves the customer app and API from one Caddy origin with real Auth0 identity and persistent Vault.
- [Live adapter and asynchronous provider writes](https://docs.neobank.proofof.tech/reference/adrs/0012-live-adapter-and-asynchronous-provider-writes.md): The neobank uses one live adapter, asynchronous operations, browser-approved grants, and read-only reconciliation.
- [Money objects for every monetary field](https://docs.neobank.proofof.tech/reference/adrs/0013-money-objects-for-every-monetary-field.md): Every monetary response field is a Money, NonNegativeMoney, or SignedMoney object; no bare decimal beside a sibling currency survives.
- [One beneficiary vocabulary](https://docs.neobank.proofof.tech/reference/adrs/0014-one-beneficiary-vocabulary.md): The contract speaks beneficiary everywhere - one noun, one join name, one ownership polarity, a total projection, and validated purpose codes.
- [One redirect action shape](https://docs.neobank.proofof.tech/reference/adrs/0015-one-redirect-action-shape.md): Every hosted-URL hand-off publishes one RedirectAction with a kind discriminator, per-field nullability, and enforced per-kind guarantees.
- [Tags, transitions, and one identity read](https://docs.neobank.proofof.tech/reference/adrs/0016-tags-transitions-and-one-identity-read.md): Operator routes get their own tag, every customer-requestable state change is a POST transition, and onboarding is the one identity read.
- [Persist the verification status](https://docs.neobank.proofof.tech/reference/adrs/0017-persist-the-verification-status-the-provider-will-not-timestamp.md): KYC status is persisted per customer and provider binding with observation timestamps, and an absent or unrecognized provider answer never demotes it.
- [Bound the idempotency window](https://docs.neobank.proofof.tech/reference/adrs/0018-bound-the-idempotency-window-and-name-a-replay.md): Idempotency keys are honoured for a stored twenty-four-hour window, replays carry Idempotent-Replayed true, and expired keys are refused, never re-executed.
- [Environment variables](https://docs.neobank.proofof.tech/reference/environment-variables.md): Configure fake or live mode, identity, data services, provider origins, Vault, and server deployment.
- [Glossary](https://docs.neobank.proofof.tech/reference/glossary.md): Define the identity, operation, approval, mandate, adapter, and provider terms used by the neobank.
- [Security model](https://docs.neobank.proofof.tech/security/model.md): Review identity, credential encryption, authorization, idempotency, uncertainty, and public-data boundaries.

## OpenAPI Specs

- [openapi](https://docs.neobank.proofof.tech/openapi.json)