Skip to main content
POST
/
tenant
/
{tenantId}
/
custodians
/
wallets-to-creating
Retrieves wallet information required to create a new custodian for the tenant.
curl --request POST \
  --url https://api.example.com/tenant/{tenantId}/custodians/wallets-to-creating \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Path Parameters

​
tenantId
integer<int64>
required

Identifier of the tenant preparing the new custodian.

Body

application/json

Payload describing the custodian provider credentials and account details.

Describes the data required to fetch wallet information prior to creating a custodian.

​
tenantId
integer<int64>

Identifier of the tenant preparing the custodian.

Example:

1024

​
accountName
string

Name that identifies the custodian account.

Example:

"Alpha Treasury Desk"

​
provider
enum<string>

Provider that will host the custodian.

Available options:
Unknown,
Fireblocks,
Venly,
Bitgo,
AnchorageDigital,
CoinbaseCustody,
FireblocksSandbox
Example:

"Fireblocks"

​
apiKey
string

Primary API key issued by the custodian provider.

Example:

"fd0cdd6d-2f89-46f0-9904-ff5a1bb5f6c3"

​
secretApiKey
string

Secret API key or credential required to authenticate with the provider.

Example:

"super-secret-key"

Response

200 - application/json

Returned when the wallet data is 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.

Example:
{
  "existingWalletsCount": 4,
  "existingWalletsNetworkCount": 2,
  "unsupportedWalletsCount": 1,
  "unsupportedWalletsNetworkCount": 1,
  "archivedWalletsCount": 3,
  "newWalletsCount": 5,
  "newWalletsNetworkCount": 2,
  "requestId": "1e2f6d7c-8a91-4bc3-951f-12d34f56a789",
  "isWrongCredentials": false
}