Skip to main content
POST
Plan a shareholder redemption
Determine whether a redemption is immediate or requires underlying source liquidation.
MicroVaults are in private preview for enabled sandbox organizations on Ethereum Sepolia.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

vaultId
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Example:

"8f4c52d7-62ab-4db9-a964-92f481f6b851"

Body

application/json
owner
string
required

Valid nonzero EVM EOA or contract address. Mixed-case values must use a valid EIP-55 checksum.

Required string length: 42
Pattern: ^0x(?!0{40}$)[0-9a-fA-F]{40}$
Example:

"0x3bf25a73a1f1033c2d50ac65f3c9d6a44123db81"

receiver
string
required

Valid nonzero EVM EOA or contract address. Mixed-case values must use a valid EIP-55 checksum.

Required string length: 42
Pattern: ^0x(?!0{40}$)[0-9a-fA-F]{40}$
Example:

"0x3bf25a73a1f1033c2d50ac65f3c9d6a44123db81"

shares
string
required

Unsigned base-10 integer string. Asset and share amounts use token base units.

Pattern: ^(0|[1-9][0-9]*)$
Example:

"1000000"

minAssetsOut
string
required

Unsigned base-10 integer string. Asset and share amounts use token base units.

Pattern: ^(0|[1-9][0-9]*)$
Example:

"1000000"

Response

Immediate or asynchronous redemption route for the requested shares.

plan
object
required