Custodian
Account

Account

Accounts represent your end users. Creating an account provisions custodial wallet addresses across supported networks. All endpoints on this page require authentication.

Create Account

Provisions a new custodial account and its wallets.

POST /api/v1/account/create

Request Body

FieldTypeRequiredDescription
subIDstringYesYour external identifier for this account (must be unique)
poolTypestringNodedicated or organization_owned. Required for hybrid apps
{
  "subID": "user-123",
  "poolType": "dedicated"
}

Response 200

{
  "message": "success create wallet",
  "data": {
    "status": "pending",
    "subId": "user-123",
    "accountId": "acc_abc123"
  }
}

status can be pending, active_no_addresses, active, or failed.

CodeMeaning
400Invalid JSON or invalid poolType
409subID already exists
500Wallet creation failed

Get Account

Returns the account and all its wallets.

GET /api/v1/account/:subID

Response 200

{
  "message": "success get account",
  "data": {
    "id": "acc_abc123",
    "subId": "user-123",
    "status": "active",
    "poolType": "dedicated",
    "wallets": [
      {
        "walletId": "wal_1",
        "network": "ethereum",
        "address": "0xabc...",
        "addressType": "evm"
      }
    ]
  }
}
CodeMeaning
404Account not found

Get Wallet by ID

GET /api/v1/account/:subID/wallet/:walletID

Response 200

{
  "message": "success get wallet",
  "data": {
    "account": {
      "id": "acc_abc123",
      "subId": "user-123",
      "status": "active",
      "poolType": "dedicated"
    },
    "walletId": "wal_1",
    "network": "ethereum",
    "address": "0xabc...",
    "addressType": "evm"
  }
}
CodeMeaning
404Account or wallet not found

Get Wallet by Network

Returns the account's wallet for a specific network.

GET /api/v1/account/:subID/network/:network

:network is a network code, e.g. ethereum. Response shape matches Get Wallet by ID.

CodeMeaning
404Account or wallet not found