Sign in

v1

latestOpenAPI 3.0.12026-08-061638881007.6 KB
Omnibus

Create a new omnibus structure within a domain

post/v1/domains/{domainId}/omnibus

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