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

Documentation Index

Fetch the complete documentation index at: https://docs.numium.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

Returns all custodian providers registered in the platform. Custodians are third-party custody providers (such as Fireblocks) that manage blockchain wallets on behalf of the platform.

​
Input

No request body required. This is a GET operation that retrieves all custodians.

​
Output

Returns a collection of custodian descriptors, each containing:
  • id (long) — Unique identifier of the custodian.
  • provider (string) — Name of the custody provider (e.g., “Fireblocks”).
  • accountName (string) — Display name for the custodian account.
  • isActive (bool) — Whether the custodian is currently active.

​
Examples

Request 
GET /api/platform/custodians
Response (200 OK) 
{
  "data": [
    {
      "id": 42,
      "provider": "Fireblocks",
      "accountName": "Production Treasury",
      "isActive": true
    },
    {
      "id": 43,
      "provider": "Fireblocks",
      "accountName": "Testing Environment",
      "isActive": false
    }
  ],
  "isSuccess": true
}

​
Errors

  • 401 Unauthorized: Authentication required but not provided.
  • 403 Forbidden: Caller does not have permission to view custodians.
  • 500 Internal Server Error: Unexpected error occurred during retrieval.

​
Notes

This endpoint requires platform administrator privileges. Only active custodians will synchronize wallets automatically.

Query Parameters

​
api-version
string | null

Response

Custodians 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[] | null

The result value returned when the operation is successful.