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

​
Description

Retrieves a filtered list of custodians that are specifically authorized to use a particular wallet, based on configured permissions and access control rules.

​
Input

  • walletId (long, required) — Route parameter identifying the wallet to query.
  • Tenant context is automatically resolved from the current authenticated session.

​
Output

Returns a WalletCustodiansClientModel containing:
  • walletId (long) — The queried wallet’s identifier.
  • custodians (array) — List of authorized custodian details with identifiers, names, permissions, and active status.

​
Examples

Request 
GET /api/platform/admin/gasstation/wallet/501/allowed-custodians
Response (200 OK) 
{
  "data": {
    "walletId": 501,
    "custodians": [
      {
        "id": 1,
        "name": "Authorized Custodian A",
        "type": "Institutional",
        "isActive": true,
        "permissions": ["read", "transact"]
      },
      {
        "id": 3,
        "name": "Authorized Custodian B",
        "type": "Individual",
        "isActive": true,
        "permissions": ["read"]
      }
    ]
  },
  "success": true
}

​
Errors

  • 400 Bad Request: Invalid wallet ID format.
  • 401 Unauthorized: Caller is not authenticated.
  • 403 Forbidden: Caller lacks permission to view wallet custodian permissions.
  • 404 Not Found: Wallet with the specified ID does not exist or tenant context is invalid.
  • 500 Internal Server Error: An unexpected server error occurred or tenant context could not be resolved.

​
Notes

Requires platform administrator privileges. This endpoint returns only custodians with explicit “allowed to use” permissions, which may be a subset of all associated custodians. The tenant context is automatically determined from the authenticated user session.

Path Parameters

​
walletId
integer<int64>
required

Identifier of the wallet to inspect.

Query Parameters

​
api-version
string | null

Response

Permitted custodians successfully retrieved.

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.