{"templateId":"markdown","versions":[{"version":"v1.43","label":"v1.43 LTS","link":"/pt-br/products/custody/deployment/reference/omnibus","default":true,"active":false,"folderId":"714bb270"},{"version":"v1.42","label":"v1.42 STS","link":"/pt-br/products/custody/v1.42/deployment/reference/omnibus","default":false,"active":true,"folderId":"714bb270"},{"version":"v1.41","label":"v1.41 STS","link":"/pt-br/products/custody/v1.41/deployment/reference/omnibus","default":false,"active":false,"folderId":"714bb270"},{"version":"v1.34","label":"v1.34 LTS","link":"/pt-br/products/custody/v1.34/deployment/reference/omnibus","default":false,"active":false,"folderId":"714bb270"},{"version":"v1.26","label":"v1.26 LTS","link":"/pt-br/products/custody/v1.26/deployment/reference/omnibus","default":false,"active":false,"folderId":"714bb270"},{"version":"v1.19","label":"v1.19 LTS","link":"/pt-br/products/custody/v1.19/deployment/reference/omnibus","default":false,"active":false,"folderId":"714bb270"},{"version":"v1.15","label":"v1.15 LTS","link":"/pt-br/products/custody/v1.15/deployment/reference/omnibus","default":false,"active":false,"folderId":"714bb270"}],"sharedDataIds":{"sidebar":"sidebar-@l10n/pt-BR/products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Omnibus reference","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"omnibus-reference","__idx":0},"children":["Omnibus reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this page to understand the main deployment settings and runtime relationships for the Omnibus Service. The example shows one possible configuration shape; your release package, database, secrets, and workflow settings can differ."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page applies to on-premise deployments. Ripple manages Omnibus deployment for SaaS."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-this-config-controls","__idx":1},"children":["What this config controls"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Omnibus is a pooled-custody add-on that uses one custody account as the omnibus wallet and tracks tenant positions in off-chain virtual account records. It stores operational state in PostgreSQL, coordinates long-running workflows, records settled balance movements in the Accounting Service, and uses system-signed intents for automated operations such as deposit wallet creation, deposit sweeps, and ledger propagation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"runtime-dependencies","__idx":2},"children":["Runtime dependencies"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before deploying Omnibus, confirm connectivity to:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Dependency"},"children":["Dependency"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Used for"},"children":["Used for"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ripple Custody"," API gateway"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Domains, accounts, intents, events, balances, and transaction state."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PostgreSQL with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pg_trgm"]}," extension"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Omnibus structure metadata, virtual accounts, deposit wallets, reservations, quarantined balances, operations, transfers, and event-processing state. If the extension isn't available, the service fails its schema migration and doesn't start."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Temporal"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Multi-step workflow orchestration and retries."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accounting Service"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Settled virtual account balances, entries, statements, and exports."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notification Server"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User-signed operations such as omnibus creation and withdrawals."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gas Station"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Native-token sponsorship for non-native token sweeps on supported Solana, XRPL, and EVM networks."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["System-signed intents"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Service-submitted automation intents for deposit wallet creation, deposit sweeps, and ledger propagation."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configuration-fields","__idx":3},"children":["Configuration fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The exact field names depend on your deployment package. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HMZ_FEATURE_OMNIBUS"]}," deployment flag controls whether the console displays the omnibus pages, including ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/custody/v1.42/accounts-and-assets/omnibus/manage-omnibus-ui#create-the-omnibus-account"},"children":["omnibus account creation"]},". Omnibus commonly needs settings like the following:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CUSTODY_API_URL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ripple Custody"," API gateway URL."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNTING_SERVICE_URL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accounting Service URL used for ledger entries, balances, and statements."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOTIFICATION_SERVER_URL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notification Server URL used for user-signing flows."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TEMPORAL_ADDRESS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Temporal cluster address."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POSTGRES_URL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PostgreSQL connection string. The target database requires the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#runtime-dependencies"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pg_trgm"]}," extension"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Service authentication settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Deployment-specific settings that let the Omnibus service authenticate to the ","Ripple Custody"," API gateway."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EVENT_POLL_INTERVAL_MS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Polling interval for custody events."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MIN_SWEEP_AMOUNT_*"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Per-ticker dust threshold for deposit sweeps, expressed in the ticker's smallest unit. You can also manage thresholds per domain at runtime with the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/custody/v1.42/accounts-and-assets/omnibus/manage-omnibus-api#manage-sweep-thresholds"},"children":["sweep thresholds API"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OTEL_EXPORTER_OTLP_ENDPOINT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OpenTelemetry collector endpoint."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Secrets"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Store database credentials and service-authentication secrets in your secret-management system. Do not put secrets directly in values files or source control."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"deployment-values","__idx":4},"children":["Deployment values"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This example shows one possible Omnibus configuration shape:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"omnibus:\n  enabled: true\n  custodyApiUrl: \"https://gateway.example.com\"\n  accountingServiceUrl: \"http://accounting-service:8080\"\n  notificationServerUrl: \"http://notification-server:8080\"\n  temporalAddress: \"temporal.example.com:7233\"\n  eventPollIntervalMs: 5000\n\n  database:\n    host: \"postgres.example.com\"\n    port: 5432\n    name: \"omnibus\"\n    username: \"omnibus_user\"\n    existingSecret: \"omnibus-db-credentials\"\n\n  serviceAuthentication:\n    existingSecret: \"omnibus-service-auth\"\n\n  dustThresholds:\n    MIN_SWEEP_AMOUNT_USDC: \"1000000\"\n\n  telemetry:\n    enabled: true\n    otlpEndpoint: \"http://otel-collector:4317\"\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"database-state","__idx":5},"children":["Database state"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Omnibus stores structure metadata, virtual accounts, deposit wallets, local reservations, local quarantined balances, operations, transfers, event processing state, and workflow correlation data."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Accounting Service remains the source of truth for settled available balances. Omnibus limits local balance data to transient reserved and quarantined states."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"workflows","__idx":6},"children":["Workflows"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Omnibus uses workflow orchestration for multi-step operations such as:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Omnibus creation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Deposit wallet creation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Deposit detection, quarantine release tracking, and sweeps."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Withdrawals."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ledger propagation from the omnibus wallet to deposit wallets."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Incoming direct deposits to the omnibus wallet."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configure workflow retention, retry, and worker scaling according to your expected event volume."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"event-polling","__idx":7},"children":["Event polling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Omnibus monitors custody events such as:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransactionDetected"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransactionUpdated"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransferUpdated"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AccountCreated"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AccountUpdated"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PolicyCreated"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When multiple Omnibus replicas run, stable workflow IDs and event IDs provide idempotency and duplicate suppression."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"system-signed-automation","__idx":8},"children":["System-signed automation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Omnibus automation uses system-signed intents. Before the service submits automation intents, the deployment must have system-signed intents active and the target domain must have a matching ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SystemSigned"]}," policy."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Confirm that:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Gateway can sign system-signed proposals."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The active Gateway public signing key is registered in Notary with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purpose: \"SystemSignatures\""]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOTARY_SYSTEM_SIGNED_INTENTS_ENABLED"]}," is set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled: true"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The Omnibus domain has a policy with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["intentOrigin: \"SystemSigned\""]}," for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_CreateAccount"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_CreateTransactionOrder"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_AddAccountLedgers"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The policy condition matches the Omnibus service submitter, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["context.submitter.subject"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["context.submitter.custodyRoles"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For activation details, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/custody/v1.42/deployment/reference/system-signed-intents"},"children":["System-signed intent configuration"]},". For the Omnibus policy shape, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/custody/v1.42/accounts-and-assets/omnibus/setup-and-governance#required-policy"},"children":["Setup and governance"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-topics","__idx":9},"children":["Related topics"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Topic"},"children":["Topic"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Documentation"},"children":["Documentation"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Omnibus concepts"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/custody/v1.42/accounts-and-assets/omnibus/overview"},"children":["Omnibus"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Setup and governance"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/custody/v1.42/accounts-and-assets/omnibus/setup-and-governance"},"children":["Setup and governance"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gas Station"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/custody/v1.42/deployment/reference/gas-station"},"children":["Gas Station reference"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PostgreSQL"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/custody/v1.42/deployment/reference/postgresql"},"children":["PostgreSQL configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Telemetry"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/custody/v1.42/deployment/reference/telemetry-configuration"},"children":["Telemetry configuration"]}]}]}]}]}]}]},"headings":[{"value":"Omnibus reference","id":"omnibus-reference","depth":1},{"value":"What this config controls","id":"what-this-config-controls","depth":2},{"value":"Runtime dependencies","id":"runtime-dependencies","depth":2},{"value":"Configuration fields","id":"configuration-fields","depth":2},{"value":"Deployment values","id":"deployment-values","depth":2},{"value":"Database state","id":"database-state","depth":2},{"value":"Workflows","id":"workflows","depth":2},{"value":"Event polling","id":"event-polling","depth":2},{"value":"System-signed automation","id":"system-signed-automation","depth":2},{"value":"Related topics","id":"related-topics","depth":2}],"frontmatter":{"seo":{"title":"Omnibus reference"}},"lastModified":"2026-10-23T14:40:24.022Z","isTranslationFallback":true,"pagePropGetterError":{"message":"","name":""}},"slug":"/pt-br/products/custody/v1.42/deployment/reference/omnibus","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}