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

​
Description

Initiates a manual synchronization operation that connects to the external custodian provider (e.g., Fireblocks), retrieves the current list of wallets, and imports any new wallets that are not yet present in the platform. Existing wallets are not modified.

​
Input

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

​
Output

Returns a response object containing:
  • success (bool) — Whether the synchronization was successful.
  • newWalletsCount (int) — Number of new wallets imported during synchronization.
  • totalWalletsCount (int) — Total number of wallets found in the custodian account.
  • message (string) — Confirmation message.

​
Examples

Request 
POST /api/platform/custodians/42/synchronize
Response (200 OK) 
{
  "data": {
    "success": true,
    "newWalletsCount": 3,
    "totalWalletsCount": 18,
    "message": "Synchronization completed successfully. 3 new wallets imported."
  },
  "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 synchronize custodians.
  • 404 Not Found: Custodian with specified ID does not exist or is inactive.
  • 500 Internal Server Error: Connection to custodian provider failed or unexpected error occurred.

​
Notes

This operation connects to the external provider using the stored API credentials. Only new wallets are imported; existing wallets retain their current settings. The synchronization applies the custodian’s default wallet sync settings to newly imported wallets.

Path Parameters

​
id
integer<int64>
required

The unique identifier of the custodian to synchronize.

Query Parameters

​
api-version
string | null

Response

Synchronization completed 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:
{ "countNewWalletsCreated": 2 }