Skip to main content
GET
/
tenant
/
{tenantId}
/
custodians
/
{id}
/
wallets
Retrieves wallets that belong to a custodian under the provided tenant.
curl --request GET \
  --url https://api.example.com/tenant/{tenantId}/custodians/{id}/wallets
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Path Parameters

​
tenantId
integer<int64>
required

Identifier of the tenant whose custodian wallets are requested.

​
id
integer<int64>
required

Identifier of the custodian whose wallets should be returned.

Query Parameters

​
onlyActive
boolean
default:true

Defines whether inactive wallets should be excluded from the response.

Response

200 - application/json

Returned when wallets are 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.

Example:
{
  "custodianId": 42,
  "custodianName": "Alpha Treasury Desk",
  "custodianProvider": "Fireblocks",
  "wallets": [
    {
      "walletTenantId": 1024,
      "walletId": 84,
      "metadataJson": "{\"label\":\"Treasury\"}",
      "blockchainId": 137,
      "network": "Polygon",
      "networkIcon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA",
      "address": "0x1234567890abcdef1234567890abcdef12345678",
      "isVisible": true,
      "isActive": true,
      "isTreasuryEnabled": true,
      "isGasStationEnabled": false
    }
  ]
}