Allowlisting API
Platform
Platform Account Operations
Create a platform account with an ACTIVE
status.
WARNING Integrators should make sure that the depositor has gone through an effective KYC/KYB process and is deemed within appetite to stake their ETH through the Liquid Collective.
When creating the depositor an integrator should supply a non-empty, unique identifying key
(it can typically be an internal user identifier).
As long as a depositor remains in ACTIVE
status, it is possible to attach wallets to it that will automatically be submitted to the protocol on-chain allowlist.
/v0/platform/accounts
Unique identifier of the account (supplied by the client)
depositor_example
Set account's status to REMOVED
.
Integrators can call this method for their inactive users to be removed from the liquid staking protocol(s) allowlist.
Once account's status has been set to REMOVED
:
- It is no longer possible to attach new wallets to the account
- Alluvial will remove any previously attached wallets from protocol's on-chain allowlist
Removing a wallet from the protocol allowlist results in disabling the ability to stake or redeem ETH.
Note that removing a wallet from the allowlist is an asynchronous process that can take some time.
/v0/platform/accounts/{idOrKey}/remove
Account ID or Key of the account to remove
Set account's status to PAUSED
.
Once an account's status has been set to PAUSED
:
- If the account has
allowlisted
wallet they will be unable to stake nor redeem. - Wallets will be able to transfer LsETH normally.
- Accounts won't be able to add new wallets.
/v0/platform/accounts/{idOrKey}/pause
Account ID or Key of the account to remove
Set a PAUSED
account's status to ACTIVE
.
This will enable the account to stake and redeem again (if the account has allowlisted
wallets), and enable you to add more wallets to the account.
This is only possible for PAUSED
accounts - DENIED
or REMOVED
accounts cannot be reactivated.
/v0/platform/accounts/{idOrKey}/reactivate
Account ID or Key of the account to reactivate
Platform Wallet Operations
Get platform wallet
/v0/platform/wallets/{idOrAddress}
Wallet ID or Address of the wallet (address in hex format prefixed with 0x)
List platform wallets
/v0/platform/wallets
Enable to only return allowlisted wallets
Enable to only return wallets on_platform
Offset for pagination
Limit for pagination
Platform Account Wallet Operations
Create a wallet attached to an account
If the account is in ACTIVE
status and if the wallet's has the allowlisted
property set to true Alluvial will add the wallet address to the protocol on-chain allowlist.
Adding a wallet to the protocol allowlist results in enabling the wallet to proceed to deposit and redeem ETH on the protocol.
Note that submitting the wallet to the on-chain allowlist is an asynchronous process that can take some time. The onboarding allows to check the submission status by getting the wallet.
Important Notes:
- Alluvial will never ask for private keys of the wallets**
- You will only be able to create
allowlisted
wallets if your organization is configured to do so. - If your organization is able to
allowlist
wallets, it method will do so by default.
/v0/platform/accounts/{idOrKey}/wallets
Account ID or Key of the account to add wallets to
Wallet address in hexadecimal format with 0x prefix
0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045
Opt out of wallet being added to the OnPlatform list
true
The type of wallet - chain or protocol it exists on
ETH
List all wallets for a platform account
/v0/platform/accounts/{idOrKey}/wallets
Account ID or Key of the account
Enable to only return allowlisted wallets
Enable to only return wallets on_platform
Offset for pagination
Limit for pagination
Remove wallet from a given wallet from either the on_platform
, the allowlisted
, or both.
/v0/platform/accounts/{idOrKey}/wallets/{idOrAddress}/remove
Account ID or Key of the account to remove wallet from
Wallet ID or Address of the wallet to be removed
Enable to remove wallet from the allowlist
Enable to remove wallet on_platform
Set wallet's status to PAUSED
.
Once a wallet's status has been set to PAUSED
:
- If the wallet was
allowlisted
, it will be unable to stake nor redeem. - Wallet will be able to transfer LsETH normally.
/v0/platform/accounts/{idOrKey}/wallets/{idOrAddress}/pause
Depositor ID or Key of the depositor to pause wallet from
Wallet ID or Address of the wallet to be paused
Enable to pause wallet from the allowlist
Enable to pause wallet on_platform
Set a PAUSED
wallet's status to ACTIVE
.
This will enable the wallet to stake and redeem again.
This action can only be performed under these conditions:
- The wallet has
PAUSED
status -DENIED
orREMOVED
wallets cannot be reactivated. - A wallet can only be reactivated if the associated account has an
ACTIVE
status.
/v0/platform/accounts/{idOrKey}/wallets/{idOrAddress}/reactivate
Depositor ID or Key of the depositor to reactivate wallet from
Wallet ID or Address of the wallet to be reactivated
Enable to reactivate wallet from the allowlist
Enable to reactivate wallet on_platform
Last updated
Was this helpful?