Create Vault Lock
Requests locking funds from the vault’s available balance for off-chain settlement or escrow. Returns the created lock (200), or the pending lock request (202) when a policy requires approval.
Authentication
✅ Organization User (CustomerEmployee)❌ Delegated User (
EndUser)✅ Service Account
Required Permissions
Vaults:Locks:Create: Always required.Authorizations
Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows
User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows
Path Parameters
Vault id.
1 - 64^vlt-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$Body
The EVM network the locked asset is on.
ArbitrumOne, ArbitrumSepolia, Arc, ArcTestnet, Areum, AvalancheC, AvalancheCFuji, Base, BaseSepolia, Bob, BobSepolia, Bsc, BscTestnet, Berachain, BerachainBepolia, Celo, CeloAlfajores, Codex, CodexSepolia, Ethereum, EthereumClassic, EthereumClassicMordor, EthereumSepolia, EthereumHoodi, FlareC, FlareCCoston2, FlowEvm, FlowEvmTestnet, Ink, InkSepolia, Optimism, OptimismSepolia, Plasma, PlasmaTestnet, Plume, PlumeSepolia, Polygon, PolygonAmoy, Rayls, RaylsTestnet, Robinhood, RobinhoodSepolia, SeiPacific1, SeiAtlantic2, Sonic, SonicTestnet, Tempo, TempoModerato, Tsc, TscTestnet1, Xdc, XdcApothem, XLayer, XLayerSepolia The token identifier of the asset to lock (e.g. native:eth or erc20:0x...).
The amount to lock, in minimum denomination.
^\d+$A unique id from your system. Unique per vault among live locks: a replacement lock inherits it, and it cannot be reused by a new lock, even after the lock is deleted.
1 - 50An optional reason or note for the lock.
The address on network the locked funds are sent to when the owner transfers the lock. Immutable once set; a lock without a beneficiary can only be released.
Response
Success
Vault lock object: funds manually locked for off-chain settlement or escrow. The owner can release them back to the vault or transfer them to the beneficiary.
Vault lock id.
1 - 64^vlt-lck-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"vlt-lck-0lf1e-8a8ag-2ak7vrvusrj3so0j"
The user that created the lock. Only this user can update or delete it.
The reason or note the lock was created with.
The address the locked funds are sent to on transfer. Set at creation and inherited on update.
Set when the owner transferred the lock: the outgoing transfer sending transferAmount of the locked funds to the beneficiary. The funds stay locked until that transfer is confirmed, which deletes the lock. Cleared if the transfer fails, so the lock can be transferred again.
Set with transferId: the amount being sent to the beneficiary, in minimum denomination. The remainder of the locked amount returns to the available balance when the lock is deleted.
Set when this lock was created by an update: the lock it replaces.
1 - 64^vlt-lck-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"vlt-lck-0lf1e-8a8ag-2ak7vrvusrj3so0j"
Set when this lock was released by an update: the lock that replaced it.
1 - 64^vlt-lck-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"vlt-lck-0lf1e-8a8ag-2ak7vrvusrj3so0j"