Skip to main content
GET
Get Vault Lock

Authentication

✅ Organization User (CustomerEmployee)
❌ Delegated User (EndUser)
✅ Service Account

Required Permissions

Vaults:Read: Always required.

Authorizations

Authorization
string
header
required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

Path Parameters

vaultId
string
required

Vault id.

Required string length: 1 - 64
Pattern: ^vlt-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$
lockId
string
required

The lock to retrieve.

Required string length: 1 - 64
Pattern: ^vlt-lck-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Response

200 - application/json

Success

Vault lock object: funds manually locked for off-chain settlement or escrow.

id
string
required

Vault lock id.

Required string length: 1 - 64
Pattern: ^vlt-lck-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$
Example:

"vlt-lck-0lf1e-8a8ag-2ak7vrvusrj3so0j"

vaultId
string
required
network
string
required
tid
string
required
amount
string
required
owner
string
required

The user that created the lock. Only this user can delete it.

dateCreated
string<date-time>
required
externalId
string
reason
string

The reason or note the lock was created with.

dateDeleted
string<date-time>
Last modified on August 6, 2026