Skip to main content
PUT
/
platform
/
admin
/
tenant
/
wallets
/
{id}
/
custodians
/
{custodianId}
/
is_active
Update custodian relationship status
curl --request PUT \
  --url https://api.example.com/platform/admin/tenant/wallets/{id}/custodians/{custodianId}/is_active
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Changes the active status of a custodian relationship for a wallet. Custodians are external services (like Fireblocks, Coinbase Custody) that provide key management and transaction signing capabilities.

​
Input

  • id (long, required) - The wallet tenant identifier (route parameter)
  • custodianId (long, required) - The custodian identifier (route parameter)
  • value (bool, required) - The new active status (query parameter): true to activate, false to deactivate

​
Output

Returns a containing:
  • success (bool) - Indicates if the operation succeeded
  • message (string, optional) - Additional information about the operation

​
Examples

Request 
PUT /api/platform/wallets/2048/custodian/42/is-active?value=true
Response (200 OK) 
{
  "success": true,
  "message": "Custodian relationship status updated successfully"
}

​
Errors

  • 400 Bad Request: Invalid wallet or custodian identifier format.
  • 401 Unauthorized: Authentication token is missing or invalid.
  • 403 Forbidden: User does not have permission to update custodial relationships.
  • 404 Not Found: Wallet or custodian relationship does not exist.
  • 500 Internal Server Error: An unexpected error occurred while updating the relationship status.

​
Notes

Deactivating a custodian relationship prevents the wallet from using that custodian service for transaction signing. At least one active custodian is typically required for operational wallets integrated with custodial services.

Path Parameters

​
id
integer<int64>
required

Identifier of the wallet tenant.

​
custodianId
integer<int64>
required

Identifier of the custodian.

Query Parameters

​
value
boolean

New active custodial relationship status (true to activate, false to deactivate).

​
api-version
string | null

Response

Wallet custodial relationship status updated 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:
{ "success": true }