/getWalletsByCustomerId

1 min

POST

Get wallets by customer ID.

return: All wallets with the given customer ID. "The return JSON includes: - AccountID: The ID of the user's account. - ActiveCurrencies: Active currencies in the account. * Address: Address of the wallet. * Currency: Coin type. - Hidden: Hidden state. Can be true or false. - WalletCustomerId: This is used to group multiple wallets together as a manageable entity. - WalletDerivationIndex: Order of wallet derivation. The first wallet created is numbered 1, the second, 2, etc. - WalletId: Wallet's ID in string. The ID is a unique identifier for the wallet. - WalletName: Wallet's name in string. The name does not need to be unique."

example: "getWalletsByCustomerId(1, "GK8 rocks!")"

-------------------- Request --------------------
{
    "FunctionData": {
        "AccountId": 1,
        "CustomerId": "test-customer",
        "ShowHidden": true,
        "ShowOnlyWalletsWithActiveCurrencies": false
    },
    "Meta": {
        "AccessToken": "0bce05191472acd3d1332b8cb788ffd7df3db3cd837e09303f9452b269992565",
        "Destination": "c887c47bc794af25ded05db43a1a2776586dcebec90efe7be3778bf6fb44c6161c7b3d1041cf72c44cd54f50b1267abd9889923448f30765dc888486316927d8ee",
        "FunctionName": "getWalletsByCustomerId",
        "RandomData": "2c999f645250ff005aa0f6f9a500337551a69bd02dc9c7a6f3b2ba5b50ab7d2c",
        "Source": "0418a72e0a0925ef7858b9c265aed7888f1e71efbd44c73fbdbcaffada08bc2334e659dc49300cffa9a8a7a9d9d6c27eb630ddb078043014a1dbb1e38f2b769058",
        "Time": "2025-01-06 15:49:50.503989"
    }
}
-------------------- Response --------------------
{
    "FunctionData": {
        "Wallets": [
            {
                "AccountID": 1,
                "ActiveCurrencies": [
                    {
                        "Address": "0xCf88290D530b32B2Eb4028A2c3bd2bE6BAa40848",
                        "Currency": "ETH"
                    }
                ],
                "Hidden": "False",
                "IsNftTrackable": false,
                "WalletCustomerId": "test-customer",
                "WalletDerivationIndex": 1,
                "WalletId": "w92228",
                "WalletName": ""
            }
        ]
    },
    "Meta": {
        "AccessToken": "2ca59a0a9c502112a8c1b5c9fb5ef963a5ef19450eeff0ff2b28353186d671c3",
        "Destination": "0418a72e0a0925ef7858b9c265aed7888f1e71efbd44c73fbdbcaffada08bc2334e659dc49300cffa9a8a7a9d9d6c27eb630ddb078043014a1dbb1e38f2b769058",
        "Source": "c887c47bc794af25ded05db43a1a2776586dcebec90efe7be3778bf6fb44c6161c7b3d1041cf72c44cd54f50b1267abd9889923448f30765dc888486316927d8ee",
        "Time": "2025-01-06 15:49:50.629"
    }
}

accountIdintegerthe account used in this operation

customerIdstringThe desired customer id

verifybooleanverify whether to verify if the deposit addresses is derived from a public key of the MPC. (the default is True. Securitywise you should always use it, unless you already know the address)

showHiddenbooleanui/sort boolean to set a ui flag

showOnlyWalletsWithActiveCurrenciesbooleanmark that only active wallets with active coins will be returned

acceptstringGenerated from available response content types

bodyobject

200success

curl --request POST \
     --url '/getWalletsByCustomerId?accountId=1&customerId=1&verify=True&showHidden=True&showOnlyWalletsWithActiveCurrencies=False' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "AccountId": 1,
     "CustomerId": "GK8 rocks!",
     "ShowHidden": true
     },
     "Meta": {
     "FunctionName": "getWalletsByCustomerIdRequest",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'