Skip to main content
GET
/
tenant
/
{tenantId}
/
admin
/
gas_station
/
{walletId}
/
get_wallet_custodians
/
allowed
GetAllowedToUseWalletCustodians
curl --request GET \
  --url https://api.example.com/tenant/{tenantId}/admin/gas_station/{walletId}/get_wallet_custodians/allowed
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

This endpoint retrieves all custodian providers that are allowed to be associated with a specific wallet based on tenant configuration and custodian capabilities.

​
Input

  • tenantId (path, required): Identifier of the tenant that owns the wallet
  • walletId (path, required): Identifier of the wallet to query
  • ct (optional): Token to cancel the asynchronous operation

​
Output

Returns a Result<WalletCustodiansClientModel> containing custodians permitted for use with the wallet, including both active and available custodians.

​
Examples

Request: 
GET /api/tenant/1024/gas-station/wallet/4096/custodians/allowed
Response (200 OK): 
{
  "data": {
    "walletCustodians": [
      {
        "walletCustodianId": 12,
        "custodianName": "Fireblocks"
      },
      {
        "walletCustodianId": 13,
        "custodianName": "Copper"
      },
      {
        "walletCustodianId": 15,
        "custodianName": "SelfCustody"
      }
    ]
  },
  "isSuccess": true
}

​
Errors

  • 400 Bad Request: Invalid wallet or tenant identifier format
  • 401 Unauthorized: Authentication credentials are missing or invalid
  • 403 Forbidden: User lacks permission to view custodian permissions
  • 404 Not Found: Tenant or wallet does not exist
  • 500 Internal Server Error: Unexpected server error occurred during retrieval

​
Notes

  • Returns both active custodians and those available for assignment
  • Custodian availability depends on tenant configuration and blockchain support
  • Useful for displaying custodian options in wallet configuration interfaces

Path Parameters

​
tenantId
integer<int64>
required

Identifier of the tenant.

​
walletId
integer<int64>
required

Identifier of the wallet.

Query Parameters

​
api-version
string | null

Response

Allowed custodians retrieved successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.