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

​
Description

Deletes a custodian provider configuration from the platform, including all associated wallets and synchronization settings. This is a permanent operation that removes all references to the custodian from the system.

​
Input

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

​
Output

Returns a response object containing:
  • success (bool) — Whether the deletion was successful.
  • accountName (string) — Name of the deleted custodian account for confirmation.
  • message (string) — Confirmation message.

​
Examples

Request 
DELETE /api/platform/custodians/42
Response (200 OK) 
{
  "data": {
    "success": true,
    "accountName": "Production Treasury",
    "message": "Custodian deleted successfully"
  },
  "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 delete custodians.
  • 404 Not Found: Custodian with specified ID does not exist.
  • 409 Conflict: Custodian cannot be deleted due to existing dependencies (e.g., active transactions, linked accounts).
  • 500 Internal Server Error: Unexpected error occurred during deletion.

​
Notes

This operation is irreversible. Before deletion, ensure all wallets associated with this custodian are no longer needed. The deletion will fail if there are active dependencies such as pending transactions or treasury operations.

Path Parameters

​
id
integer<int64>
required

The unique identifier of the custodian to delete.

Query Parameters

​
api-version
string | null

Response

Custodian deleted 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:
{ "accountName": "Alpha Treasury Desk" }