Skip to main content
GET
/
platform
/
admin
/
custodians
/
{id}
Get custodian details
curl --request GET \
  --url https://api.example.com/platform/admin/custodians/{id}
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Fetches detailed configuration and status information for a specific custodian provider. Returns complete settings including API configuration, operational permissions, and wallet synchronization preferences.

​
Input

  • id (long, required) — The unique identifier of the custodian to retrieve.

​
Output

Returns a detailed custodian object containing:
  • id (long) — Unique identifier of the custodian.
  • tenantId (long) — Associated tenant identifier.
  • provider (string) — Name of the custody provider (e.g., “Fireblocks”).
  • accountName (string) — Display name of the custodian account.
  • isActive (bool) — Whether the custodian is active.
  • isAllowedContractOwnership (bool) — Contract ownership permission.
  • isAllowedTreasuryOperations (bool) — Treasury operations permission.
  • walletsSyncSettings (object) — Wallet synchronization configuration.
  • createdDate (datetime) — When the custodian was created.

​
Examples

Request 
GET /api/platform/custodians/42
Response (200 OK) 
{
  "data": {
    "id": 42,
    "tenantId": 1024,
    "provider": "Fireblocks",
    "accountName": "Production Treasury",
    "isActive": true,
    "isAllowedContractOwnership": true,
    "isAllowedTreasuryOperations": true,
    "walletsSyncSettings": {
      "isVisibleWallet": true,
      "isActiveWallet": true,
      "isActiveCustodialRelationship": true,
      "isActiveTreasuryWallets": false
    },
    "createdDate": "2024-06-15T10:30:00Z"
  },
  "isSuccess": true
}

​
Errors

  • 400 Bad Request: Invalid custodian ID format.
  • 401 Unauthorized: Authentication required but not provided.
  • 403 Forbidden: Caller does not have permission to view custodian details.
  • 404 Not Found: Custodian with specified ID does not exist.
  • 500 Internal Server Error: Unexpected error occurred during retrieval.

​
Notes

This endpoint requires platform administrator privileges. The API keys are not returned in the response for security reasons.

Path Parameters

​
id
integer<int64>
required

The unique identifier of the custodian to retrieve.

Query Parameters

​
api-version
string | null

Response

Custodian 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:
{
  "id": 42,
  "treasuryWalletsCount": 3,
  "smartContractOwnersCount": 1,
  "isActive": true,
  "accountName": "Alpha Treasury Desk",
  "apiKey": "3d6f0a87-4d13-4eaa-9f3a-b8d3b761b28e",
  "provider": "Fireblocks",
  "enableContractOwnership": true,
  "enableTreasuryOperations": true,
  "isVisibleWallet": true,
  "isActiveWallet": true,
  "isActiveCustodialRelationship": true,
  "isActiveTreasuryWallets": false
}