Allowlisting API
Last updated
Last updated
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.
Account, requires external 'key' to create
Unique identifier of the account (supplied by the client)
"depositor_example"
Account has been created
Time the account was created
"2024-01-24T13:07:50.335845Z"
Identifier of the account (generated server side)
"ac0d0cdf-92bc-4cbe-a180-a2efb2387d16"
Unique key identifying the account (supplied by the client when creating the account)
"depositor_example"
Organization identifier the account belongs to
"org_28CLGCvsdG7TlOHf"
Status of the account (managed by the integrator)
"ACTIVE"
Get platform account
Account ID or Key of the platform account
OK
Time the account was created
"2024-01-24T13:07:50.335845Z"
Identifier of the account (generated server side)
"ac0d0cdf-92bc-4cbe-a180-a2efb2387d16"
Unique key identifying the account (supplied by the client when creating the account)
"depositor_example"
Organization identifier the account belongs to
"org_28CLGCvsdG7TlOHf"
Status of the account (managed by the integrator)
"ACTIVE | PAUSED | REMOVED | DENIED"
Wallets attached to the account
List platform wallets
OK
The account ID of the wallet
"ac0d0cdf-92bc-4cbe-a180-a2efb2387d16"
Wallet address in hexadecimal format with 0x prefix
"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
Whether the wallet is allowlisted
true
Time the wallet was created
"2024-01-25T13:07:50.335845Z"
Our UUID for this wallet
"dd8eefc8-0cc4-4a27-adc0-e1ebebed598d"
Whether the wallet is on platform
true
Status of the submission of the wallet account on-chain
"ALLOWLISTED"
The type of wallet - chain or protocol it exists on
"ETH"
List all wallets for a platform account
Account ID or Key of the account
OK
The account ID of the wallet
"ac0d0cdf-92bc-4cbe-a180-a2efb2387d16"
Wallet address in hexadecimal format with 0x prefix
"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
Whether the wallet is allowlisted
true
Time the wallet was created
"2024-01-25T13:07:50.335845Z"
Our UUID for this wallet
"dd8eefc8-0cc4-4a27-adc0-e1ebebed598d"
Whether the wallet is on platform
true
Status of the submission of the wallet account on-chain
"ALLOWLISTED"
The type of wallet - chain or protocol it exists on
"ETH"
Get platform wallet
Wallet ID or Address of the wallet (address in hex format prefixed with 0x)
OK
The account ID of the wallet
"ac0d0cdf-92bc-4cbe-a180-a2efb2387d16"
Wallet address in hexadecimal format with 0x prefix
"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
Whether the wallet is allowlisted
true
Time the wallet was created
"2024-01-25T13:07:50.335845Z"
Our UUID for this wallet
"dd8eefc8-0cc4-4a27-adc0-e1ebebed598d"
Whether the wallet is on platform
true
Status of the submission of the wallet account on-chain
"ALLOWLISTED"
The type of wallet - chain or protocol it exists on
"ETH"
List platform accounts
OK
Time the account was created
"2024-01-24T13:07:50.335845Z"
Identifier of the account (generated server side)
"ac0d0cdf-92bc-4cbe-a180-a2efb2387d16"
Unique key identifying the account (supplied by the client when creating the account)
"depositor_example"
Organization identifier the account belongs to
"org_28CLGCvsdG7TlOHf"
Status of the account (managed by the integrator)
"ACTIVE | PAUSED | REMOVED | DENIED"
Wallets attached to the account
Remove wallet from a given wallet from either the on_platform
, the allowlisted
, or both.
Account ID or Key of the account to remove wallet from
Wallet ID or Address of the wallet to be removed
OK
The account ID of the wallet
"ac0d0cdf-92bc-4cbe-a180-a2efb2387d16"
Wallet address in hexadecimal format with 0x prefix
"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
Time the wallet was created
"2024-01-25T13:07:50.335845Z"
Our UUID for this wallet
"dd8eefc8-0cc4-4a27-adc0-e1ebebed598d"
Status of the submission of the wallet account on-chain
"REMOVED"
The type of wallet - chain or protocol it exists on
"ETH"
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:
allowlisted
wallets if your organization is configured to do so.allowlist
wallets, it method will do so by default.Account ID or Key of the account to add wallets to
Wallet to create
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"
OK
The account ID of the wallet
"ac0d0cdf-92bc-4cbe-a180-a2efb2387d16"
Wallet address in hexadecimal format with 0x prefix
"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
Whether the wallet is allowlisted
true
Time the wallet was created
"2024-01-25T13:07:50.335845Z"
Our UUID for this wallet
"dd8eefc8-0cc4-4a27-adc0-e1ebebed598d"
Whether the wallet is on platform
true
Status of the submission of the wallet account on-chain
"ALLOWLISTED"
The type of wallet - chain or protocol it exists on
"ETH"
Set wallet's status to PAUSED
.
Once a wallet's status has been set to PAUSED
:
allowlisted
, it will be unable to stake nor redeem.Depositor ID or Key of the depositor to pause wallet from
Wallet ID or Address of the wallet to be paused
OK
The account ID of the wallet
"ac0d0cdf-92bc-4cbe-a180-a2efb2387d16"
Wallet address in hexadecimal format with 0x prefix
"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
Whether the wallet is allowlisted
true
Time the wallet was created
"2024-01-25T13:07:50.335845Z"
Our UUID for this wallet
"dd8eefc8-0cc4-4a27-adc0-e1ebebed598d"
Whether the wallet is on platform
true
Status of the submission of the wallet account on-chain, set to PAUSED
"PAUSED | ALLOWLISTED"
The type of wallet - chain or protocol it exists on
"ETH"
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:
PAUSED
status - DENIED
or REMOVED
wallets cannot be reactivated.ACTIVE
status.Depositor ID or Key of the depositor to reactivate wallet from
Wallet ID or Address of the wallet to be reactivated
OK
The account ID of the wallet
"ac0d0cdf-92bc-4cbe-a180-a2efb2387d16"
Wallet address in hexadecimal format with 0x prefix
"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
Whether the wallet is allowlisted
true
Time the wallet was created
"2024-01-25T13:07:50.335845Z"
Our UUID for this wallet
"dd8eefc8-0cc4-4a27-adc0-e1ebebed598d"
Whether the wallet is on platform
true
Status of the submission of the wallet account on-chain, set to PAUSED
"PAUSED | ALLOWLISTED"
The type of wallet - chain or protocol it exists on
"ETH"
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
:
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.
Account ID or Key of the account to remove
OK
Time the account was created
"2024-01-24T13:07:50.335845Z"
Identifier of the account (generated server side)
"ac0d0cdf-92bc-4cbe-a180-a2efb2387d16"
Unique key identifying the account (supplied by the client when creating the account)
"depositor_example"
Organization identifier the account belongs to
"org_28CLGCvsdG7TlOHf"
Status of the account (managed by the integrator)
"REMOVED"
Wallets attached to the account
Set account's status to PAUSED
.
Once an account's status has been set to PAUSED
:
allowlisted
wallet they will be unable to stake nor redeem.Account ID or Key of the account to remove
OK
Time the account was created
"2024-01-24T13:07:50.335845Z"
Identifier of the account (generated server side)
"ac0d0cdf-92bc-4cbe-a180-a2efb2387d16"
Unique key identifying the account (supplied by the client when creating the account)
"depositor_example"
Organization identifier the account belongs to
"org_28CLGCvsdG7TlOHf"
Status of the account (managed by the integrator)
"PAUSED"
Wallets attached to the account
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.
Account ID or Key of the account to reactivate
OK
Time the account was created
"2024-01-24T13:07:50.335845Z"
Identifier of the account (generated server side)
"ac0d0cdf-92bc-4cbe-a180-a2efb2387d16"
Unique key identifying the account (supplied by the client when creating the account)
"depositor_example"
Organization identifier the account belongs to
"org_28CLGCvsdG7TlOHf"
Status of the account (managed by the integrator)
"ACTIVE"
Wallets attached to the account