Accounts16

Backups3

Compliance24

Deposits3

Domains2

Endpoints2

Event Distribution Service9

Events1

Exports2

Gas station19

Genesis1

Intents7

Internal transfers3

Ledgers6

Omnibus4

Policies2

Requests3

Sweep thresholds2

SystemProperties1

SystemSigning1

Tenants6

Tickers2

Transactions7

TrustedPublicKeys3

User invitations8

Users4

Vaults4

Withdrawals1

Omnibus

Create a new omnibus structure within a domain

post/v1/domains/{domainId}/omnibus

Request

Base URL
https://docs.ripple.com (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/omnibus/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

domainIdstring uuid required

Request body

aliasstring required

Alias for the omnibus account

vaultIdstring uuid required

Identifier of the vault where the omnibus account keys will be stored

keyStrategy'VaultHard' | 'VaultSoft' | 'Random' required

lockStatus'Unlocked' | 'Locked'

ledgerIdsstring[]

List of ledger IDs to activate on the omnibus account. If omitted, all enabled ledgers compatible with the vault and key strategy are activated automatically.

descriptionstring

Optional description for the omnibus account

customPropertiesobject

Custom key-value properties for the omnibus account

ignoredAccountIdsstring[]

List of custody account IDs to ignore during event processing (e.g., Gas Station account)

sponsoringGasStationIdstring uuid

Entity ID of the Gas Station account that will sponsor fees for this omnibus account.

Response

Omnibus structure created

Changes

No recorded changes to this operation across all 3 revisions of this API.