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

​
Description

Sets the default custodian for a wallet. The default custodian is used as the primary service for transaction signing and key management operations when multiple custodians are configured.

​
Input

  • id (long, required) - The wallet tenant identifier (route parameter)
  • custodianId (long, required) - The custodian identifier to set as default (route parameter)

​
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/default
Response (200 OK) 
{
  "success": true,
  "message": "Default custodian updated successfully"
}

​
Errors

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

​
Notes

The custodian must be in an active relationship with the wallet before it can be set as the default. Only one custodian can be the default at a time. Setting a new default automatically removes the default designation from any previously configured default custodian.

Path Parameters

​
id
integer<int64>
required

Identifier of the wallet tenant.

​
custodianId
integer<int64>
required

Identifier of the custodian to set as default.

Query Parameters

​
api-version
string | null

Response

Default custodian 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 }