Skip to main content
GET
/
platform
/
admin
/
tenant
/
wallets
/
multisignature
/
{walletTenantId}
/
remove_owner
/
{ownerWalletTenantId}
Get remove owner data
curl --request GET \
  --url https://api.example.com/platform/admin/tenant/wallets/multisignature/{walletTenantId}/remove_owner/{ownerWalletTenantId}
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Description

Fetches information about a specific owner and validates whether they can be safely removed from the multisignature wallet. This includes checking threshold constraints to ensure the wallet remains functional after removal.

Input

  • walletTenantId (long, required) - The multisignature wallet tenant identifier (route parameter)
  • ownerWalletTenantId (long, required) - The owner wallet tenant identifier to remove (route parameter)

Output

Returns a containing:
  • walletTenantId (long) - The wallet tenant identifier
  • ownerWalletTenantId (long) - The owner wallet tenant identifier
  • ownerWalletName (string) - Name of the owner wallet to be removed
  • ownerAddress (string) - Address of the owner wallet
  • currentThreshold (int) - Current signature threshold
  • ownersCount (int) - Current number of owners
  • canRemove (bool) - Whether the owner can be safely removed
  • warningMessage (string, optional) - Warning if removal would affect threshold

Examples

Request
GET /api/platform/wallets/3001/owners/4096/remove
Response (200 OK)
{
  "walletTenantId": 3001,
  "ownerWalletTenantId": 4096,
  "ownerWalletName": "Owner to Remove",
  "ownerAddress": "0xfedcba9876543210fedcba9876543210fedcba98",
  "currentThreshold": 2,
  "ownersCount": 3,
  "canRemove": true,
  "warningMessage": "After removal, the wallet will have 2 owners with a threshold of 2"
}

Errors

  • 400 Bad Request: Invalid wallet or owner identifiers, or owner is not part of this wallet.
  • 401 Unauthorized: Authentication token is missing or invalid.
  • 403 Forbidden: User does not have permission to view removal data.
  • 404 Not Found: Wallet or owner wallet does not exist.
  • 500 Internal Server Error: An unexpected error occurred while retrieving removal data.

Notes

An owner cannot be removed if it would result in the number of remaining owners being less than the current threshold. In such cases, the threshold must be reduced before removing the owner.

Path Parameters

walletTenantId
integer<int64>
required

Identifier of the wallet tenant.

ownerWalletTenantId
integer<int64>
required

Identifier of the owner wallet tenant to remove.

Query Parameters

api-version
string | null

Response

Owner removal data 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:
{}