Add External Wallets

You can add the customer or counterparty self-custody or hosted crypto external wallets to the Cybrid platform using the /external_wallets endpoint, which allows you to withdraw crypto assets from the platform to those external wallets.

Types of External Wallets

There are two types of external wallets to understand in the Cybrid Platform:

Type	Description
Customer Wallets	Unique wallets that are attached to a specific customer and can only be used by the customer who created them.
Counterparty Wallets	Unique wallets that are attached to a specific counterparty of a customer or bank and can only be used by the customer or the bank that created them.
Partner (Bank-Level) Wallets	General wallets are attached to a specific bank and usable by any customer associated with that bank.

Creating External Wallets

When creating an external wallet for a customer, provide the customer_guid to associate the unique wallet for that specific customer, or provide the counterparty_guid that the wallet is associated with (Note that counterparty can belong to a bank or customer). This is useful when individual customers want to add their own or their counterparty's external wallets to withdraw assets. For general-purpose external wallets, do not provide customer_guid or counterparty_guid. This is useful if you are transferring assets from multiple customers to the same address. For example, this method would work well if your platform has an omnibus wallet designed to receive all withdrawals from the Cybrid Platform.

POST /api/external_wallets

{
  "name": "<wallet name>",
  "customer_guid": "<customer guid>",
  "asset": "<asset>",
  "address": "<blockchain wallet address>",
  "tag": "<string>"
}

{
  "name": "<wallet name>",
  "counterparty_guid": "<counterparty guid>",
  "asset": "<asset>",
  "address": "<blockchain wallet address>",
  "tag": "<string>"
}

{
  "name": "<wallet name>",
  "asset": "<asset>",
  "address": "<blockchain wallet address>",
  "tag": "<string>"
}

Wallet Screening

All wallets undergo a screening process to determine their risk level. There are three outcomes for screened wallets:

The wallet is considered high risk, and will be automatically rejected. You can monitor the wallet that you are adding to the platform using the following API request:

GET /api/external_wallets/{external_wallet_guid}

  {
    "guid": "<wallet guid>",
    "name": "<wallet name>",
    "asset": "<asset>",
    "environment": "<production/sandbox>",
    "bank_guid": "<bank guid>",
    "customer_guid": "<customer guid>",
    "counterparty_guid": null,
    "address": "<blockchain wallet address>",
    "tag": null,
    "created_at": "<datetime>",
    "updated_at": "<datetime>",
    "state": "failed",
    "failure_code": "prohibited_address"
  }

The wallet is assessed as medium risk. Wallets in this category are sent for manual review by our Compliance team. Review targets can be found here. Once reviewed, the wallet will either be accepted or rejected.
The wallet is assessed as low risk and will be automatically accepted.