Get Vault Lock
Retrieves a vault lock by its ID.
Authentication
✅ Organization User (CustomerEmployee)❌ Delegated User (
EndUser)✅ Service Account
Required Permissions
Vaults:Read: Always required.Authorizations
Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows
Path Parameters
Vault id.
1 - 64^vlt-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$The lock to retrieve.
1 - 64^vlt-lck-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$Response
Success
Vault lock object: funds manually locked for off-chain settlement or escrow.
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.
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"